Package org.objectweb.joram.shared.client

Class AbstractJmsRequest

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

All Implemented Interfaces:

Encodable, Streamable, Externalizable, Serializable

Direct Known Subclasses:

ActivateConsumerRequest, AddClientIDRequest, CnxCloseRequest, CnxConnectRequest, CnxStartRequest, CnxStopRequest, CommitRequest, ConsumerAckRequest, ConsumerCloseSubRequest, ConsumerDenyRequest, ConsumerReceiveRequest, ConsumerSetListRequest, ConsumerSubRequest, ConsumerUnsetListRequest, ConsumerUnsubRequest, GetAdminTopicRequest, JmsRequestGroup, PingRequest, ProducerMessages, QBrowseRequest, SessAckRequest, SessCreateDestRequest, SessDenyRequest, TempDestDeleteRequest, XACnxCommit, XACnxPrepare, XACnxRecoverRequest, XACnxRollback

public abstract class AbstractJmsRequest
extends AbstractJmsMessage

An AbstractJmsRequest is a request sent by a Joram client to its proxy.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	requestId	Identifier of the request.
protected String	target	The request target is either a destination agent name, or a subscription name.

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
AbstractJmsRequest()	Constructs an AbstractJmsRequest.
AbstractJmsRequest(String target)	Constructs an AbstractJmsRequest.

Method Summary

Modifier and Type	Method	Description
void	decode(Decoder decoder)	Decodes the content of this object
void	encode(Encoder encoder)	Encodes the content of this object
int	getEncodableClassId()	Returns a unique class identifier.
int	getEncodedSize()	Returns the size of the byte array that results from the encoding of this object.
int	getRequestId()	Returns the request identifier.
String	getTarget()	Returns the request target name.
void	readFrom(InputStream is)	The object implements the readFrom method to restore its contents from the input stream.
void	setRequestId(int requestId)	Sets the request identifier.
void	setTarget(String target)	Sets the request target name.
String	toString()
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.AbstractJmsMessage

getClassId, read, readExternal, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

requestId

protected volatile int requestId

Identifier of the request. Declared volatile to allow a thread that is not the thread sending the request to get the identifier in order to cancel it during a close.

target

protected String target

The request target is either a destination agent name, or a subscription name.

Constructor Detail

AbstractJmsRequest

public AbstractJmsRequest()

Constructs an AbstractJmsRequest.

AbstractJmsRequest

public AbstractJmsRequest(String target)

Constructs an AbstractJmsRequest.

Parameters:

target - String identifier of the request target, either a queue name, or a subscription name.

Method Detail

setRequestId

public final void setRequestId(int requestId)

Sets the request identifier.

Parameters:

requestId - The request identifier.

getRequestId

public final int getRequestId()

Returns the request identifier.

Returns:

The request identifier.

setTarget

public final void setTarget(String target)

Sets the request target name.

Parameters:

target - The request target name.

getTarget

public final String getTarget()

Returns the request target name.

Returns:

The request target name.

toString

public final String toString()

Overrides:

toString in class Object

toString

public void toString(StringBuilder strbuf)

writeTo

public void writeTo(OutputStream os)
             throws IOException

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

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.

Parameters:

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

Throws:

IOException - an error occurs during IO operation.

getEncodableClassId

public int getEncodableClassId()

Description copied from interface: Encodable

Returns a unique class identifier.

Returns:

a unique class identifier

getEncodedSize

public int getEncodedSize()
                   throws Exception

Description copied from interface: Encodable

Returns the size of the byte array that results from the encoding of this object.

Returns:

the size of the encoded byte array

Throws:

Exception - if an error occurs

encode

public void encode(Encoder encoder)
            throws Exception

Description copied from interface: Encodable

Encodes the content of this object

Parameters:

encoder - the encoder to be used for the encoding

Throws:

Exception - if an error occurs

decode

public void decode(Decoder decoder)
            throws Exception

Description copied from interface: Encodable

Decodes the content of this object

Parameters:

decoder - the decoder to be used for the decoding

Throws:

Exception - if an error occurs