Package org.objectweb.joram.shared.client

Class SessAckRequest

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

org.objectweb.joram.shared.client.SessAckRequest

All Implemented Interfaces:

Encodable, Streamable, Externalizable, Serializable

public final class SessAckRequest
extends AbstractJmsRequest

A SessAckRequest instance is used by a Session for acknowledging the messages it consumed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Vector<String>	ids	Vector of message identifiers.
private boolean	queueMode	true if the request is destinated to a queue.
private static long	serialVersionUID	define serialVersionUID for interoperability

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
SessAckRequest()	Constructs a SessAckRequest instance.
SessAckRequest(String targetName, Vector<String> ids, boolean queueMode)	Constructs a SessAckRequest instance.

Method Summary

Modifier and Type	Method	Description
void	addId(String id)
void	decode(Decoder decoder)	Decodes the content of this object
void	encode(Encoder encoder)	Encodes the content of this object
protected int	getClassId()
int	getEncodableClassId()	Returns a unique class identifier.
int	getEncodedSize()	Returns the size of the byte array that results from the encoding of this object.
Vector<String>	getIds()	Returns the vector of acknowledged messages identifiers.
boolean	getQueueMode()	Returns true if the request is destination is a queue.
void	readFrom(InputStream is)	The object implements the readFrom method to restore its contents from the input stream.
void	setIds(Vector<String> ids)	Sets the vector of identifiers.
void	setQueueMode(boolean queueMode)	Sets the target destination type.
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

getRequestId, getTarget, setRequestId, setTarget, toString, 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

ids

private Vector<String> ids

Vector of message identifiers.

queueMode

private boolean queueMode

true if the request is destinated to a queue.

Constructor Detail

SessAckRequest

public SessAckRequest(String targetName,
                      Vector<String> ids,
                      boolean queueMode)

Constructs a SessAckRequest instance.

Parameters:

targetName - Name of the target queue or subscription.

ids - Vector of acknowledged message identifiers.

queueMode - true if this request is destinated to a queue.

SessAckRequest

public SessAckRequest()

Constructs a SessAckRequest instance.

Method Detail

setIds

public void setIds(Vector<String> ids)

Sets the vector of identifiers.

Parameters:

ids - The message identifiers.

addId

public void addId(String id)

getIds

public Vector<String> getIds()

Returns the vector of acknowledged messages identifiers.

Returns:

The message identifiers.

setQueueMode

public void setQueueMode(boolean queueMode)

Sets the target destination type.

Parameters:

queueMode - The target destination type.

getQueueMode

public boolean getQueueMode()

Returns true if the request is destination is a queue.

Returns:

The target destination type.

getClassId

protected int getClassId()

Specified by:

getClassId in class AbstractJmsMessage

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.

getEncodableClassId

public int getEncodableClassId()

Description copied from interface: Encodable

Returns a unique class identifier.

Specified by:

getEncodableClassId in interface Encodable

Overrides:

getEncodableClassId in class AbstractJmsRequest

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.

Specified by:

getEncodedSize in interface Encodable

Overrides:

getEncodedSize in class AbstractJmsRequest

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

Specified by:

encode in interface Encodable

Overrides:

encode in class AbstractJmsRequest

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

Specified by:

decode in interface Encodable

Overrides:

decode in class AbstractJmsRequest

Parameters:

decoder - the decoder to be used for the decoding

Throws:

Exception - if an error occurs