Package org.objectweb.joram.shared.client

Class ConsumerReceiveRequest

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

org.objectweb.joram.shared.client.ConsumerReceiveRequest

All Implemented Interfaces:

Encodable, Streamable, Externalizable, Serializable

public final class ConsumerReceiveRequest
extends AbstractJmsRequest

A ConsumerReceiveRequest is sent by a MessageConsumer when requesting a message.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	queueMode	true if the request is destinated to a queue.
private boolean	receiveAck
private String	selector	The selector for filtering messages on a queue.
private static long	serialVersionUID	define serialVersionUID for interoperability
private long	timeToLive	The time to live value of the request (negative for infinite).

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
ConsumerReceiveRequest()	Constructs a ConsumerReceiveRequest.
ConsumerReceiveRequest(String targetName, String selector, long timeToLive, boolean queueMode)	Constructs a ConsumerReceiveRequest.

Method Summary

Modifier and Type	Method	Description
protected int	getClassId()
boolean	getQueueMode()	Returns true if the request is destinated to a queue.
boolean	getReceiveAck()
String	getSelector()	Returns the selector for filtering the messages.
long	getTimeToLive()	Returns the time to live value in milliseconds.
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	setReceiveAck(boolean receiveAck)
void	setSelector(String selector)	Sets the selector.
void	setTimeToLive(long timeToLive)	Sets the time to live value.
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, 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

The selector for filtering messages on a queue.

timeToLive

private long timeToLive

The time to live value of the request (negative for infinite).

queueMode

private boolean queueMode

true if the request is destinated to a queue.

receiveAck

private boolean receiveAck

Constructor Detail

ConsumerReceiveRequest

public ConsumerReceiveRequest(String targetName,
                              String selector,
                              long timeToLive,
                              boolean queueMode)

Constructs a ConsumerReceiveRequest.

Parameters:

targetName - Name of the target queue or subscription.

selector - The selector for filtering messages, if any.

timeToLive - Time to live value in milliseconds, negative for infinite.

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

ConsumerReceiveRequest

public ConsumerReceiveRequest()

Constructs a ConsumerReceiveRequest.

Method Detail

setSelector

public void setSelector(String selector)

Sets the selector.

Parameters:

selector - The selector.

getSelector

public String getSelector()

Returns the selector for filtering the messages.

Returns:

The selector.

setTimeToLive

public void setTimeToLive(long timeToLive)

Sets the time to live value.

Parameters:

timeToLive - The time to live value.

getTimeToLive

public long getTimeToLive()

Returns the time to live value in milliseconds.

Returns:

The time to live value.

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.

setReceiveAck

public void setReceiveAck(boolean receiveAck)

getReceiveAck

public final boolean getReceiveAck()

getClassId

protected int getClassId()

Specified by:

getClassId in class AbstractJmsMessage

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.