Package org.objectweb.joram.mom.notifications

Class ClientMessages

java.lang.Object

fr.dyade.aaa.agent.Notification

fr.dyade.aaa.agent.CallbackNotification

org.objectweb.joram.mom.notifications.AbstractNotification

org.objectweb.joram.mom.notifications.AbstractRequestNot

org.objectweb.joram.mom.notifications.ClientMessages

All Implemented Interfaces:

Encodable, Serializable, Cloneable

Direct Known Subclasses:

FtpNot

public class ClientMessages
extends AbstractRequestNot

A ClientMessages instance is used by a client agent for sending one or many messages to a destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientMessages.Factory

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	asyncSend
private Message	message	Message sent by the client.
private List<Message>	messages	Messages sent by the client.
private AgentId	proxyId
private static long	serialVersionUID	define serialVersionUID for interoperability

Fields inherited from class fr.dyade.aaa.agent.Notification

detachable, detached, persistent

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
ClientMessages()	Constructs a ClientMessages instance.
ClientMessages(int clientContext, int requestId)	Constructs a ClientMessages instance.
ClientMessages(int clientContext, int requestId, List<Message> messages)	Constructs a ClientMessages instance.
ClientMessages(int clientContext, int requestId, Message message)	Constructs a ClientMessages instance.

Method Summary

Modifier and Type	Method	Description
void	addMessage(Message msg)	Adds a message to deliver.
void	decode(Decoder decoder)	Decodes the object.
void	encode(Encoder encoder)	Encodes the object.
boolean	getAsyncSend()
AgentId	getDMQId()	Returns the identifier of the producer's dead message queue, if any.
int	getEncodableClassId()	The class id is still not defined.
int	getEncodedSize()	Returns the size of the encoded object.
int	getMessageCount()
List<Message>	getMessages()	Returns the messages.
AgentId	getProxyId()
void	setAsyncSend(boolean b)
void	setDMQId(AgentId dmqId)	Sets the identifier of the producer's dead message queue.
void	setProxyId(AgentId proxyId)
StringBuilder	toString(StringBuilder output)	Appends a string image for this object to the StringBuilder parameter.

Methods inherited from class org.objectweb.joram.mom.notifications.AbstractRequestNot

getRequestId

Methods inherited from class org.objectweb.joram.mom.notifications.AbstractNotification

getClientContext, setPersistent

Methods inherited from class fr.dyade.aaa.agent.CallbackNotification

done, failed, hasCallback, passCallback, setCountDownCallback

Methods inherited from class fr.dyade.aaa.agent.Notification

clone, getContext, getDeadNotificationAgentId, getExpiration, getMessageId, getPriority, isPersistent, setContext, setDeadNotificationAgentId, setExpiration, setPriority, toString

Methods inherited from class java.lang.Object

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

message

private Message message

Message sent by the client.

messages

private List<Message> messages

Messages sent by the client.

asyncSend

private boolean asyncSend

proxyId

private AgentId proxyId

Constructor Detail

ClientMessages

public ClientMessages(int clientContext,
                      int requestId)

Constructs a ClientMessages instance.

Parameters:

clientContext - Identifies a client context.

requestId - Request identifier.

ClientMessages

public ClientMessages(int clientContext,
                      int requestId,
                      Message message)

Constructs a ClientMessages instance.

Parameters:

clientContext - Identifies a client context.

requestId - Request identifier.

message - The message.

ClientMessages

public ClientMessages(int clientContext,
                      int requestId,
                      List<Message> messages)

Constructs a ClientMessages instance.

Parameters:

clientContext - Identifies a client context.

requestId - Request identifier.

messages - Vector of messages.

ClientMessages

public ClientMessages()

Constructs a ClientMessages instance.

Method Detail

getEncodableClassId

public int getEncodableClassId()

Description copied from class: Notification

The class id is still not defined.

Specified by:

getEncodableClassId in interface Encodable

Overrides:

getEncodableClassId in class Notification

Returns:

a unique class identifier

getEncodedSize

public int getEncodedSize()
                   throws Exception

Description copied from class: Notification

Returns the size of the encoded object.

Specified by:

getEncodedSize in interface Encodable

Overrides:

getEncodedSize in class AbstractRequestNot

Returns:

the size of the encoded object

Throws:

Exception - if an error occurs

encode

public void encode(Encoder encoder)
            throws Exception

Description copied from class: Notification

Encodes the object.

Specified by:

encode in interface Encodable

Overrides:

encode in class AbstractRequestNot

Parameters:

encoder - the encoder

Throws:

Exception - if an error occurs

decode

public void decode(Decoder decoder)
            throws Exception

Description copied from class: Notification

Decodes the object.

Specified by:

decode in interface Encodable

Overrides:

decode in class AbstractRequestNot

Parameters:

decoder - the encoder

Throws:

Exception - if an error occurs

getProxyId

public AgentId getProxyId()

setProxyId

public void setProxyId(AgentId proxyId)

addMessage

public void addMessage(Message msg)

Adds a message to deliver.

setDMQId

public void setDMQId(AgentId dmqId)

Sets the identifier of the producer's dead message queue. Basically, it simply calls Notification.setDeadNotificationAgentId(AgentId)

getMessages

public List<Message> getMessages()

Returns the messages.

setAsyncSend

public void setAsyncSend(boolean b)

getAsyncSend

public final boolean getAsyncSend()

getMessageCount

public int getMessageCount()

getDMQId

public AgentId getDMQId()

Returns the identifier of the producer's dead message queue, if any. Basically, it simply calls Notification.getDeadNotificationAgentId()

toString

public StringBuilder toString(StringBuilder output)

Appends a string image for this object to the StringBuilder parameter.

Overrides:

toString in class AbstractRequestNot

Parameters:

output - buffer to fill in

Returns:

output buffer is returned