Package org.objectweb.joram.shared.client

Class ProducerMessages

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

org.objectweb.joram.shared.client.ProducerMessages

All Implemented Interfaces:

Encodable, Streamable, Externalizable, Serializable

public final class ProducerMessages
extends AbstractJmsRequest

A ProducerMessages instance is sent by a MessageProducer when sending messages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	asyncSend	Indicates whether the produced messages are asynchronously send or not (without or with an acknowledgement).
private Vector<Message>	messages	The wrapped messages.
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
ProducerMessages()	Constructs a ProducerMessages instance.
ProducerMessages(String dest)	Constructs a ProducerMessages instance.
ProducerMessages(String dest, Message msg)	Constructs a ProducerMessages instance carrying a single message.

Method Summary

Modifier and Type	Method	Description
void	addMessage(Message msg)	Adds a message to deliver.
void	addMessages(Vector<Message> msgs)	Adds messages to deliver.
void	decode(Decoder decoder)	Decodes the content of this object
void	encode(Encoder encoder)	Encodes the content of this object
boolean	getAsyncSend()
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<Message>	getMessages()	Returns the produced messages
void	readFrom(InputStream is)	The object implements the readFrom method to restore its contents from the input stream.
void	setAsyncSend(boolean b)
void	setMessages(Vector<Message> newMsgs)	Replace old messages vector by new newMsgs vector
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

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

messages

private Vector<Message> messages

The wrapped messages.

asyncSend

private boolean asyncSend

Indicates whether the produced messages are asynchronously send or not (without or with an acknowledgement).

Constructor Detail

ProducerMessages

public ProducerMessages(String dest)

Constructs a ProducerMessages instance.

Parameters:

dest - Name of the destination the messages are sent to.

ProducerMessages

public ProducerMessages(String dest,
                        Message msg)

Constructs a ProducerMessages instance carrying a single message.

Parameters:

dest - Name of the destination the messages are sent to.

msg - Message to carry.

ProducerMessages

public ProducerMessages()

Constructs a ProducerMessages instance.

Method Detail

setAsyncSend

public void setAsyncSend(boolean b)

getAsyncSend

public final boolean getAsyncSend()

getMessages

public Vector<Message> getMessages()

Returns the produced messages

Returns:

The produced messages.

addMessage

public void addMessage(Message msg)

Adds a message to deliver.

Parameters:

msg - The message to add.

addMessages

public void addMessages(Vector<Message> msgs)

Adds messages to deliver.

Parameters:

msgs - The messages to add

setMessages

public void setMessages(Vector<Message> newMsgs)

Replace old messages vector by new newMsgs vector

Parameters:

newMsgs - new messages vector.

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.

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