Package org.objectweb.joram.shared.client

Class ConsumerSubRequest

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

org.objectweb.joram.shared.client.ConsumerSubRequest

All Implemented Interfaces:

Encodable, Streamable, Externalizable, 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

Fields

Modifier and Type	Field	Description
private boolean	asyncSub	asynchronous subscription.
private String	clientID
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 String	selector	The selector for filtering messages.
private static long	serialVersionUID	define serialVersionUID for interoperability
private boolean	shared
private 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, 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
ConsumerSubRequest()	Constructs a ConsumerSubRequest.
ConsumerSubRequest(String topic, String subName, String selector, boolean noLocal, boolean durable, boolean asyncSub, String clientID, boolean shared)	Constructs a ConsumerSubRequest.

Method Summary

Modifier and Type	Method	Description
protected int	getClassId()
String	getClientID()
boolean	getDurable()	Returns true for a durable subscription.
boolean	getNoLocal()	Returns true for not consuming the local messages.
String	getSelector()	Returns the selector for filtering the messages.
String	getSubName()	Returns the name of the subscription.
boolean	isAsyncSubscription()	Returns true for asynchronous subscription.
boolean	isShared()
void	readFrom(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(String selector)	Sets the selector.
void	setSubName(String subName)	Sets the subscription name.
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

subName

private String subName

The subscription's name.

asyncSub

private boolean asyncSub

asynchronous subscription.

selector

private 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.

clientID

private String clientID

shared

private boolean shared

Constructor Detail

ConsumerSubRequest

public ConsumerSubRequest(String topic,
                          String subName,
                          String selector,
                          boolean noLocal,
                          boolean durable,
                          boolean asyncSub,
                          String clientID,
                          boolean shared)

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.

clientID - The clientID

shared - true if the consumer is shared

ConsumerSubRequest

public ConsumerSubRequest()

Constructs a ConsumerSubRequest.

Method Detail

setSubName

public void setSubName(String subName)

Sets the subscription name.

Parameters:

subName - the subscription name.

getSubName

public String getSubName()

Returns the name of the subscription.

Returns:

the name of the subscription.

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.

setNoLocal

public void setNoLocal(boolean noLocal)

Sets the noLocal attribute.

Parameters:

noLocal - The noLocal attribute.

getNoLocal

public boolean getNoLocal()

Returns true for not consuming the local messages.

Returns:

The noLocal attribute.

setDurable

public void setDurable(boolean durable)

Sets the durable attribute.

Parameters:

durable - The durable attribute.

getDurable

public boolean getDurable()

Returns true for a durable subscription.

Returns:

The durable attribute.

getClientID

public String getClientID()

Returns:

The clientID

isShared

public boolean isShared()

Returns:

true if shared

isAsyncSubscription

public boolean isAsyncSubscription()

Returns true for asynchronous subscription.

Returns:

True for asynchronous subscription.

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.