Package org.objectweb.joram.mom.notifications

Class TopicForwardNot

java.lang.Object

fr.dyade.aaa.agent.Notification

fr.dyade.aaa.agent.CallbackNotification

org.objectweb.joram.mom.notifications.TopicForwardNot

All Implemented Interfaces:

Encodable, Serializable, Cloneable

public final class TopicForwardNot
extends CallbackNotification

A TopicForwardNot is a notification sent by a topic to another topic part of the same cluster, or to its hierarchical father, and holding a forwarded ClientMessages notification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopicForwardNot.Factory

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	fromCluster	true if the notification is destinated to a hierarchical father.
private ClientMessages	messages	The forwarded messages.
private static long	serialVersionUID

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
TopicForwardNot()
TopicForwardNot(ClientMessages messages, boolean fromCluster)	Constructs a TopicForwardNot instance.

Method Summary

Modifier and Type	Method	Description
void	decode(Decoder decoder)	Decodes the object.
void	encode(Encoder encoder)	Encodes the object.
int	getEncodableClassId()	The class id is still not defined.
int	getEncodedSize()	Returns the size of the encoded object.
ClientMessages	getMessages()
boolean	isFromCluster()
void	setPersistent(boolean persistent)
StringBuilder	toString(StringBuilder output)	Appends a string image for this object to the StringBuffer parameter.

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

See Also:

Constant Field Values

fromCluster

private boolean fromCluster

true if the notification is destinated to a hierarchical father.

messages

private ClientMessages messages

The forwarded messages.

Constructor Detail

TopicForwardNot

public TopicForwardNot()

TopicForwardNot

public TopicForwardNot(ClientMessages messages,
                       boolean fromCluster)

Constructs a TopicForwardNot instance.

Parameters:

messages - Notification to forward.

fromCluster - true if the notification is coming from a cluster friend.

Method Detail

isFromCluster

public boolean isFromCluster()

Returns:

the fromCluster

getMessages

public ClientMessages getMessages()

Returns:

the messages

setPersistent

public void setPersistent(boolean persistent)

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 Notification

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 Notification

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 Notification

Parameters:

decoder - the encoder

Throws:

Exception - if an error occurs

toString

public StringBuilder toString(StringBuilder output)

Description copied from class: Notification

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

Overrides:

toString in class Notification

Parameters:

output - buffer to fill in.

Returns:

the resulting buffer.