Package org.objectweb.joram.shared.client

Class ConsumerSetListRequest

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

org.objectweb.joram.shared.client.ConsumerSetListRequest

All Implemented Interfaces:

Encodable, Streamable, Externalizable, Serializable

public final class ConsumerSetListRequest
extends AbstractJmsRequest

A ConsumerSetListRequest is sent by a MessageConsumer on which a message listener is set.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private int	msgCount
private String[]	msgIdsToAck
private boolean	queueMode	true if the request is destinated to a queue.
private String	selector	Selector for filtering messages on a queue.
private static long	serialVersionUID	define serialVersionUID for interoperability

Fields inherited from class org.objectweb.joram.shared.client.AbstractJmsRequest

requestId, target

Fields inherited from class org.objectweb.joram.shared.client.AbstractJmsMessage

ACTIVATE_CONSUMER_REQUEST, ADD_CLIENTID_REPLY, ADD_CLIENTID_REQUEST, classid, classnames, CNX_CLOSE_REPLY, CNX_CLOSE_REQUEST, CNX_CONNECT_REPLY, CNX_CONNECT_REQUEST, CNX_START_REQUEST, CNX_STOP_REQUEST, COMMIT_REQUEST, CONSUMER_ACK_REQUEST, CONSUMER_CLOSE_SUB_REQUEST, CONSUMER_DENY_REQUEST, CONSUMER_MESSAGES, CONSUMER_RECEIVE_REQUEST, CONSUMER_SET_LIST_REQUEST, CONSUMER_SUB_REQUEST, CONSUMER_UNSET_LIST_REQUEST, CONSUMER_UNSUB_REQUEST, GET_ADMIN_TOPIC_REPLY, GET_ADMIN_TOPIC_REQUEST, JMS_REQUEST_GROUP, MOM_EXCEPTION_REPLY, NULL_CLASS_ID, PING_REQUEST, PRODUCER_MESSAGES, QBROWSE_REPLY, QBROWSE_REQUEST, SERVER_REPLY, SESS_ACK_REQUEST, SESS_CREATE_DEST_REPLY, SESS_CREATE_DEST_REQUEST, SESS_DENY_REQUEST, TEMP_DEST_DELETE_REQUEST, XA_CNX_COMMIT, XA_CNX_PREPARE, XA_CNX_RECOVER_REPLY, XA_CNX_RECOVER_REQUEST, XA_CNX_ROLLBACK, XXX_SESS_CREATE_TTREQUEST

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable

BOOLEAN_ENCODED_SIZE, BYTE_ENCODED_SIZE, DOUBLE_ENCODED_SIZE, FLOAT_ENCODED_SIZE, INT_ENCODED_SIZE, LONG_ENCODED_SIZE, SHORT_ENCODED_SIZE

Constructor Summary

Constructors

Constructor	Description
ConsumerSetListRequest()	Constructs a ConsumerSetListRequest.
ConsumerSetListRequest(String targetName, String selector, boolean queueMode, String[] msgIdsToAck, int msgCount)	Constructs a ConsumerSetListRequest.

Method Summary

Modifier and Type	Method	Description
protected int	getClassId()
int	getMessageCount()
String[]	getMessageIdsToAck()
boolean	getQueueMode()	Returns true if the request is destinated to a queue.
String	getSelector()	Returns the selector for filtering messages.
void	readFrom(InputStream is)	The object implements the readFrom method to restore its contents from the input stream.
void	setQueueMode(boolean queueMode)	Sets the target destination type.
void	setSelector(String selector)	Sets the selector.
void	toString(StringBuilder strbuf)
void	writeTo(OutputStream os)	The object implements the writeTo method to write its contents to the output stream.

Methods inherited from class org.objectweb.joram.shared.client.AbstractJmsRequest

decode, encode, getEncodableClassId, getEncodedSize, getRequestId, getTarget, setRequestId, setTarget, toString

Methods inherited from class org.objectweb.joram.shared.client.AbstractJmsMessage

read, readExternal, write, writeExternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

define serialVersionUID for interoperability

See Also:

Constant Field Values

selector

private String selector

Selector for filtering messages on a queue.

queueMode

private boolean queueMode

true if the request is destinated to a queue.

msgIdsToAck

private String[] msgIdsToAck

msgCount

private int msgCount

Constructor Detail

ConsumerSetListRequest

public ConsumerSetListRequest(String targetName,
                              String selector,
                              boolean queueMode,
                              String[] msgIdsToAck,
                              int msgCount)

Constructs a ConsumerSetListRequest.

Parameters:

targetName - Name of the target queue or subscription.

selector - Selector for filtering messages.

queueMode - true if this request is destinated to a queue.

msgIdsToAck - Identifiers of messages to ack.

msgCount - Number of messages.

ConsumerSetListRequest

public ConsumerSetListRequest()

Constructs a ConsumerSetListRequest.

Method Detail

setSelector

public void setSelector(String selector)

Sets the selector.

Parameters:

selector - The selector.

getSelector

public String getSelector()

Returns the selector for filtering messages.

Returns:

The selector.

setQueueMode

public void setQueueMode(boolean queueMode)

Sets the target destination type.

Parameters:

queueMode - The target destination type.

getQueueMode

public boolean getQueueMode()

Returns true if the request is destinated to a queue.

Returns:

The target destination type.

getMessageIdsToAck

public final String[] getMessageIdsToAck()

getMessageCount

public final int getMessageCount()

getClassId

protected int getClassId()

Specified by:

getClassId in class AbstractJmsMessage

toString

public void toString(StringBuilder strbuf)

Overrides:

toString in class AbstractJmsRequest

writeTo

public void writeTo(OutputStream os)
             throws IOException

The object implements the writeTo method to write its contents to the output stream.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class AbstractJmsRequest

Parameters:

os - the stream to write the object to

Throws:

IOException - an error occurs during IO operation.

readFrom

public void readFrom(InputStream is)
              throws IOException

The object implements the readFrom method to restore its contents from the input stream.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class AbstractJmsRequest

Parameters:

is - the stream to read data from in order to restore the object

Throws:

IOException - an error occurs during IO operation.