Joram 5.2.1

org.objectweb.joram.shared.client
Class ConsumerReceiveRequest

java.lang.Object
  extended by org.objectweb.joram.shared.client.AbstractJmsMessage
      extended by org.objectweb.joram.shared.client.AbstractJmsRequest
          extended by org.objectweb.joram.shared.client.ConsumerReceiveRequest
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, Streamable

public final class ConsumerReceiveRequest
extends AbstractJmsRequest

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

See Also:
Serialized Form

Field Summary
 
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, 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, logger, MOM_EXCEPTION_REPLY, NULL_CLASS_ID, PING_REQUEST, PRODUCER_MESSAGES, QBROWSE_REPLY, QBROWSE_REQUEST, SERVER_REPLY, SESS_ACK_REQUEST, SESS_CREATE_TDREPLY, SESS_CREATE_TQREQUEST, SESS_CREATE_TTREQUEST, SESS_DENY_REQUEST, TEMP_DEST_DELETE_REQUEST, XA_CNX_COMMIT, XA_CNX_PREPARE, XA_CNX_RECOVER_REPLY, XA_CNX_RECOVER_REQUEST, XA_CNX_ROLLBACK
 
Constructor Summary
ConsumerReceiveRequest()
          Constructs a ConsumerReceiveRequest.
ConsumerReceiveRequest(java.lang.String targetName, java.lang.String selector, long timeToLive, boolean queueMode)
          Constructs a ConsumerReceiveRequest.
 
Method Summary
protected  int getClassId()
           
 boolean getQueueMode()
          Returns true if the request is destinated to a queue.
 boolean getReceiveAck()
           
 java.lang.String getSelector()
          Returns the selector for filtering the messages.
 long getTimeToLive()
          Returns the time to live value in milliseconds.
 void readFrom(java.io.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(java.lang.String selector)
          Sets the selector.
 void setTimeToLive(long timeToLive)
          Sets the time to live value.
 void writeTo(java.io.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
getRequestId, getTarget, setRequestId, setTarget, toString, toString
 
Methods inherited from class org.objectweb.joram.shared.client.AbstractJmsMessage
read, readExternal, soapCode, soapDecode, write, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConsumerReceiveRequest

public ConsumerReceiveRequest(java.lang.String targetName,
                              java.lang.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(java.lang.String selector)
Sets the selector.


getSelector

public java.lang.String getSelector()
Returns the selector for filtering the messages.


setTimeToLive

public void setTimeToLive(long timeToLive)
Sets the time to live value.


getTimeToLive

public long getTimeToLive()
Returns the time to live value in milliseconds.


setQueueMode

public void setQueueMode(boolean queueMode)
Sets the target destination type.


getQueueMode

public boolean getQueueMode()
Returns true if the request is destinated to a queue.


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(java.io.OutputStream os)
             throws java.io.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:
java.io.IOException

readFrom

public void readFrom(java.io.InputStream is)
              throws java.io.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:
java.io.IOException

Joram 5.2.1

Copyright © 2005 Scalagent - All rights reserved