org.objectweb.joram.shared.client
Class ConsumerSubRequest

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.ConsumerSubRequest
All Implemented Interfaces:
Streamable, java.io.Externalizable, java.io.Serializable

public final class ConsumerSubRequest
extends AbstractJmsRequest

A ConsumerSubRequest is sent by a constructing MessageConsumer destinated to consume messages on a topic.

See Also:
Serialized Form

Field Summary
private  boolean asyncSub
          asynchronous subscription.
private  boolean durable
          true if the subscription is durable.
private  boolean noLocal
          true if the subscriber does not wish to consume messages produced by its connection.
private  java.lang.String selector
          The selector for filtering messages.
private static long serialVersionUID
           
private  java.lang.String subName
          The subscription's name.
 
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_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
 
Constructor Summary
ConsumerSubRequest()
          Constructs a ConsumerSubRequest.
ConsumerSubRequest(java.lang.String topic, java.lang.String subName, java.lang.String selector, boolean noLocal, boolean durable, boolean asyncSub)
          Constructs a ConsumerSubRequest.
 
Method Summary
protected  int getClassId()
           
 boolean getDurable()
          Returns true for a durable subscription.
 boolean getNoLocal()
          Returns true for not consuming the local messages.
 java.lang.String getSelector()
          Returns the selector for filtering the messages.
 java.lang.String getSubName()
          Returns the name of the subscription.
 boolean isAsyncSubscription()
          Returns true for asynchronous subscription.
 void readFrom(java.io.InputStream is)
          The object implements the readFrom method to restore its contents from the input stream.
 void setDurable(boolean durable)
          Sets the durable attribute.
 void setNoLocal(boolean noLocal)
          Sets the noLocal attribute.
 void setSelector(java.lang.String selector)
          Sets the selector.
 void setSubName(java.lang.String subName)
          Sets the subscription name.
 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
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

subName

private java.lang.String subName
The subscription's name.


asyncSub

private boolean asyncSub
asynchronous subscription.


selector

private java.lang.String selector
The selector for filtering messages.


noLocal

private boolean noLocal
true if the subscriber does not wish to consume messages produced by its connection.


durable

private boolean durable
true if the subscription is durable.

Constructor Detail

ConsumerSubRequest

public ConsumerSubRequest(java.lang.String topic,
                          java.lang.String subName,
                          java.lang.String selector,
                          boolean noLocal,
                          boolean durable,
                          boolean asyncSub)
Constructs a ConsumerSubRequest.

Parameters:
topic - The topic identifier the client wishes to subscribe to.
subName - The subscription's name.
selector - The selector for filtering messages, if any.
noLocal - true for not consuming the local messages.
durable - true for a durable subscription.
asyncSub - true for a asynchronous subscription request.

ConsumerSubRequest

public ConsumerSubRequest()
Constructs a ConsumerSubRequest.

Method Detail

setSubName

public void setSubName(java.lang.String subName)
Sets the subscription name.


getSubName

public java.lang.String getSubName()
Returns the name of the subscription.


setSelector

public void setSelector(java.lang.String selector)
Sets the selector.


getSelector

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


setNoLocal

public void setNoLocal(boolean noLocal)
Sets the noLocal attribute.


getNoLocal

public boolean getNoLocal()
Returns true for not consuming the local messages.


setDurable

public void setDurable(boolean durable)
Sets the durable attribute.


getDurable

public boolean getDurable()
Returns true for a durable subscription.


isAsyncSubscription

public boolean isAsyncSubscription()
Returns true for asynchronous subscription.


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


Copyright © 2010 ScalAgent D.T.. All Rights Reserved.