org.objectweb.joram.shared.client.AbstractJmsRequest Class Reference

Inherits org.objectweb.joram.shared.client.AbstractJmsMessage.

Inherited by org.objectweb.joram.shared.client.ActivateConsumerRequest, org.objectweb.joram.shared.client.CnxCloseRequest, org.objectweb.joram.shared.client.CnxConnectRequest, org.objectweb.joram.shared.client.CnxStartRequest, org.objectweb.joram.shared.client.CnxStopRequest, org.objectweb.joram.shared.client.CommitRequest, org.objectweb.joram.shared.client.ConsumerAckRequest, org.objectweb.joram.shared.client.ConsumerCloseSubRequest, org.objectweb.joram.shared.client.ConsumerDenyRequest, org.objectweb.joram.shared.client.ConsumerReceiveRequest, org.objectweb.joram.shared.client.ConsumerSetListRequest, org.objectweb.joram.shared.client.ConsumerSubRequest, org.objectweb.joram.shared.client.ConsumerUnsetListRequest, org.objectweb.joram.shared.client.ConsumerUnsubRequest, org.objectweb.joram.shared.client.GetAdminTopicRequest, org.objectweb.joram.shared.client.JmsRequestGroup, org.objectweb.joram.shared.client.PingRequest, org.objectweb.joram.shared.client.ProducerMessages, org.objectweb.joram.shared.client.QBrowseRequest, org.objectweb.joram.shared.client.SessAckRequest, org.objectweb.joram.shared.client.SessCreateTQRequest, org.objectweb.joram.shared.client.SessCreateTTRequest, org.objectweb.joram.shared.client.SessDenyRequest, org.objectweb.joram.shared.client.TempDestDeleteRequest, org.objectweb.joram.shared.client.XACnxCommit, org.objectweb.joram.shared.client.XACnxPrepare, org.objectweb.joram.shared.client.XACnxRecoverRequest, and org.objectweb.joram.shared.client.XACnxRollback.

Inheritance diagram for org.objectweb.joram.shared.client.AbstractJmsRequest:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.joram.shared.client.AbstractJmsRequest:

Collaboration graph
[legend]
List of all members.

Public Member Functions

final void setRequestId (int requestId)
final synchronized int getRequestId ()
final void setTarget (String target)
final String getTarget ()
 AbstractJmsRequest ()
 AbstractJmsRequest (String target)
final String toString ()
void toString (StringBuffer strbuf)
void writeTo (OutputStream os) throws IOException
void readFrom (InputStream is) throws IOException

Protected Attributes

volatile int requestId = -1
String target = null

Detailed Description

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

Definition at line 36 of file AbstractJmsRequest.java.


Constructor & Destructor Documentation

org.objectweb.joram.shared.client.AbstractJmsRequest.AbstractJmsRequest (  ) 

Constructs an AbstractJmsRequest.

Definition at line 75 of file AbstractJmsRequest.java.

org.objectweb.joram.shared.client.AbstractJmsRequest.AbstractJmsRequest ( String  target  ) 

Constructs an AbstractJmsRequest.

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

Definition at line 83 of file AbstractJmsRequest.java.


Member Function Documentation

final void org.objectweb.joram.shared.client.AbstractJmsRequest.setRequestId ( int  requestId  ) 

Sets the request identifier.

Definition at line 47 of file AbstractJmsRequest.java.

final synchronized int org.objectweb.joram.shared.client.AbstractJmsRequest.getRequestId (  ) 

Returns the request identifier.

Definition at line 52 of file AbstractJmsRequest.java.

References org.objectweb.joram.shared.client.AbstractJmsRequest.requestId.

Referenced by org.objectweb.joram.shared.client.CnxConnectReply.CnxConnectReply(), org.objectweb.joram.shared.client.GetAdminTopicReply.GetAdminTopicReply(), org.objectweb.joram.mom.proxies.RequestBuffer.put(), org.objectweb.joram.mom.proxies.ProxyImpl.reactToClientRequest(), org.objectweb.joram.mom.proxies.soap.SoapProxyService.send(), org.objectweb.joram.shared.client.ServerReply.ServerReply(), org.objectweb.joram.shared.client.SessCreateTDReply.SessCreateTDReply(), and org.objectweb.joram.shared.client.XACnxRecoverReply.XACnxRecoverReply().

final void org.objectweb.joram.shared.client.AbstractJmsRequest.setTarget ( String  target  ) 

Sets the request target name.

Definition at line 63 of file AbstractJmsRequest.java.

Referenced by org.objectweb.joram.client.jms.MessageConsumerListener.close().

final String org.objectweb.joram.shared.client.AbstractJmsRequest.getTarget (  ) 

Returns the request target name.

Definition at line 68 of file AbstractJmsRequest.java.

References org.objectweb.joram.shared.client.AbstractJmsRequest.target.

Referenced by org.objectweb.joram.mom.proxies.RequestBuffer.put().

void org.objectweb.joram.shared.client.AbstractJmsRequest.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

Implements org.objectweb.joram.shared.stream.Streamable.

Reimplemented in org.objectweb.joram.shared.client.ActivateConsumerRequest, org.objectweb.joram.shared.client.CommitRequest, org.objectweb.joram.shared.client.ConsumerAckRequest, org.objectweb.joram.shared.client.ConsumerDenyRequest, org.objectweb.joram.shared.client.ConsumerReceiveRequest, org.objectweb.joram.shared.client.ConsumerSetListRequest, org.objectweb.joram.shared.client.ConsumerSubRequest, org.objectweb.joram.shared.client.ConsumerUnsetListRequest, org.objectweb.joram.shared.client.JmsRequestGroup, org.objectweb.joram.shared.client.ProducerMessages, org.objectweb.joram.shared.client.QBrowseRequest, org.objectweb.joram.shared.client.SessAckRequest, org.objectweb.joram.shared.client.SessDenyRequest, org.objectweb.joram.shared.client.XACnxCommit, org.objectweb.joram.shared.client.XACnxPrepare, and org.objectweb.joram.shared.client.XACnxRollback.

Definition at line 110 of file AbstractJmsRequest.java.

References org.objectweb.joram.shared.client.AbstractJmsRequest.requestId, and org.objectweb.joram.shared.client.AbstractJmsRequest.target.

Referenced by org.objectweb.joram.shared.client.JmsRequestGroup.writeTo().

void org.objectweb.joram.shared.client.AbstractJmsRequest.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

Implements org.objectweb.joram.shared.stream.Streamable.

Reimplemented in org.objectweb.joram.shared.client.ActivateConsumerRequest, org.objectweb.joram.shared.client.CommitRequest, org.objectweb.joram.shared.client.ConsumerAckRequest, org.objectweb.joram.shared.client.ConsumerDenyRequest, org.objectweb.joram.shared.client.ConsumerReceiveRequest, org.objectweb.joram.shared.client.ConsumerSetListRequest, org.objectweb.joram.shared.client.ConsumerSubRequest, org.objectweb.joram.shared.client.ConsumerUnsetListRequest, org.objectweb.joram.shared.client.JmsRequestGroup, org.objectweb.joram.shared.client.ProducerMessages, org.objectweb.joram.shared.client.QBrowseRequest, org.objectweb.joram.shared.client.SessAckRequest, org.objectweb.joram.shared.client.SessDenyRequest, org.objectweb.joram.shared.client.XACnxCommit, org.objectweb.joram.shared.client.XACnxPrepare, and org.objectweb.joram.shared.client.XACnxRollback.

Definition at line 121 of file AbstractJmsRequest.java.

References org.objectweb.joram.shared.client.AbstractJmsRequest.requestId, and org.objectweb.joram.shared.client.AbstractJmsRequest.target.

Referenced by org.objectweb.joram.shared.client.JmsRequestGroup.readFrom().


Member Data Documentation

volatile int org.objectweb.joram.shared.client.AbstractJmsRequest.requestId = -1 [protected]

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.

Definition at line 42 of file AbstractJmsRequest.java.

Referenced by org.objectweb.joram.shared.client.AbstractJmsRequest.getRequestId(), org.objectweb.joram.shared.client.AbstractJmsRequest.readFrom(), org.objectweb.joram.shared.client.AbstractJmsRequest.toString(), and org.objectweb.joram.shared.client.AbstractJmsRequest.writeTo().

String org.objectweb.joram.shared.client.AbstractJmsRequest.target = null [protected]

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

Definition at line 60 of file AbstractJmsRequest.java.

Referenced by org.objectweb.joram.shared.client.AbstractJmsRequest.getTarget(), org.objectweb.joram.shared.client.XACnxRollback.readFrom(), org.objectweb.joram.shared.client.AbstractJmsRequest.readFrom(), org.objectweb.joram.shared.client.AbstractJmsRequest.toString(), and org.objectweb.joram.shared.client.AbstractJmsRequest.writeTo().


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:20:55 2008 for joram by  doxygen 1.5.0