Package org.objectweb.joram.mom.notifications

Class AbstractNotification

java.lang.Object

fr.dyade.aaa.agent.Notification

fr.dyade.aaa.agent.CallbackNotification

org.objectweb.joram.mom.notifications.AbstractNotification

All Implemented Interfaces:

Encodable, Serializable, Cloneable

Direct Known Subclasses:

AbstractReplyNot, AbstractRequestNot, AdminReplyNot, AdminRequestNot

public abstract class AbstractNotification
extends CallbackNotification

The AbstractNotification class is the superclass of the notifications exchanged by a client agent and a MOM destination agent.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private int	clientContext	The clientContext field allows a client to identify a context within which a notification is exchanged with a destination.
private static long	serialVersionUID	define serialVersionUID for interoperability, fix with 5.15.0 value

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
AbstractNotification()	Constructs an AbstractNotification.
AbstractNotification(int clientContext)	Constructs an AbstractNotification.

Method Summary

Modifier and Type	Method	Description
void	decode(Decoder decoder)	Decodes the object.
void	encode(Encoder encoder)	Encodes the object.
int	getClientContext()	Returns the client context identifier.
int	getEncodedSize()	Returns the size of the encoded object.
void	setPersistent(boolean persistent)
StringBuilder	toString(StringBuilder output)	Appends a string image for this object to the StringBuilder 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, getEncodableClassId, 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, fix with 5.15.0 value

See Also:

Constant Field Values

clientContext

private int clientContext

The clientContext field allows a client to identify a context within which a notification is exchanged with a destination.

This field is for the client use only and might not be set.

Constructor Detail

AbstractNotification

public AbstractNotification(int clientContext)

Constructs an AbstractNotification.

Parameters:

clientContext - Identifies a client context.

AbstractNotification

public AbstractNotification()

Constructs an AbstractNotification.

Method Detail

getClientContext

public int getClientContext()

Returns the client context identifier.

setPersistent

public void setPersistent(boolean persistent)

toString

public StringBuilder toString(StringBuilder output)

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

Overrides:

toString in class Notification

Parameters:

output - buffer to fill in

Returns:

output buffer is returned

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