java.lang.Object
- fr.dyade.aaa.agent.Message

All Implemented Interfaces:

Encodable, Serializable
```
public final class Message
extends Object
implements Serializable, Encodable
```
The internal message structure. A message is divided in 2 parts:
- An immutable part with source and destination agent unique id, and notification object.
- A variable part containing information about message routing (next hop) and the current stamp of the message.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class Message.Factory

Field Summary

Fields
Modifier and Type	Field	Description
`private static boolean`	`DEBUG`
`(package private) short`	`dest`	The unique id. of destination server
`(package private) static byte`	`DETACHABLE`
`(package private) AgentId`	`from`	`AgentId` of sender.
`(package private) static int`	`LENGTH`
`static Logger`	`logger`
`(package private) Notification`	`not`	The notification.
`(package private) static byte`	`NOTNULL`
`(package private) static byte`	`NULL`
`(package private) static byte`	`PERSISTENT`
`private static Pool`	`pool`
`private SerializableWrapper`	`serializedNot`
`(package private) static long`	`serialVersionUID`	define serialVersionUID for interoperability
`(package private) short`	`source`	The unique id. of source server
`(package private) int`	`stamp`	The current stamp of the message
`private String`	`stringId`
`(package private) AgentId`	`to`	`AgentId` of destination agent.

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
Modifier Constructor Description

private Message()
Construct a new message.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) static Message`	`alloc()`	Allocates a message from the pool.
`(package private) static Message`	`alloc(AgentId from, AgentId to, Notification not)`	Allocates a message from the pool.
`StringBuffer`	`appendToString(StringBuffer strbuf)`	Adds a string representation for this object in the StringBuffer parameter.
`void`	`decode(Decoder decoder)`	Decodes the content of this object
`(package private) void`	`delete()`	Deletes the current object in persistent storage.
`void`	`encode(Encoder encoder)`	Encodes the content of this object
`(package private) void`	`free()`	Frees the message to the pool.
`short`	`getDest()`	Get the unique server id. of the addressee of this message
`int`	`getEncodableClassId()`	Returns a unique class identifier.
`int`	`getEncodedSize()`	Returns the size of the byte array that results from the encoding of this object.
`AgentId`	`getFrom()`
`Notification`	`getNot()`
`short`	`getSource()`	Get the unique server identifier of the sender of this message
`int`	`getStamp()`	Get the stamp of this message
`AgentId`	`getTo()`
`boolean`	`isPersistent()`	Tests if the associated notification is persistent or not.
`(package private) static Message`	`load(String name)`	Restores the object state from the persistent storage.
`(package private) void`	`optFromByte(byte opt)`
`(package private) byte`	`optToByte()`
`private void`	`readObject(ObjectInputStream in)`	The readObject method is responsible for reading from the stream and restoring the classes fields.
`(package private) void`	`save()`	Saves the object state on persistent storage.
`private void`	`set(AgentId from, AgentId to, Notification not)`
`String`	`toString()`	Returns a string representation for this object.
`(package private) String`	`toStringId()`
`private void`	`writeObject(ObjectOutputStream out)`	The writeObject method is responsible for writing the state of the object for its particular class so that the corresponding readObject method can restore it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
static final long serialVersionUID
```
    define serialVersionUID for interoperability
    
    See Also:
    
    Constant Field Values
  - logger
```
public static final Logger logger
```
  - DEBUG
```
private static final boolean DEBUG
```
  - from
```
transient AgentId from
```
    AgentId of sender.
  - to
```
transient AgentId to
```
    AgentId of destination agent.
  - not
```
transient Notification not
```
    The notification.
  - source
```
transient short source
```
    The unique id. of source server
  - dest
```
transient short dest
```
    The unique id. of destination server
  - stamp
```
transient int stamp
```
    The current stamp of the message
  - LENGTH
```
static final int LENGTH
```
    See Also:
    
    Constant Field Values
  - NULL
```
static final byte NULL
```
    See Also:
    
    Constant Field Values
  - NOTNULL
```
static final byte NOTNULL
```
    See Also:
    
    Constant Field Values
  - PERSISTENT
```
static final byte PERSISTENT
```
    See Also:
    
    Constant Field Values
  - DETACHABLE
```
static final byte DETACHABLE
```
    See Also:
    
    Constant Field Values
  - stringId
```
private transient String stringId
```
  - pool
```
private static Pool pool
```
  - serializedNot
```
private SerializableWrapper serializedNot
```
- Constructor Detail
  - Message
```
private Message()
```
    Construct a new message.
- Method Detail
  - getSource
```
public short getSource()
```
    Get the unique server identifier of the sender of this message
    
    Returns:
    
    the unique server identifier of the source.
  - getDest
```
public short getDest()
```
    Get the unique server id. of the addressee of this message
    
    Returns:
    
    the unique server identifier of the destination.
  - getStamp
```
public int getStamp()
```
    Get the stamp of this message
    
    Returns:
    
    the stamp of this message.
  - getFrom
```
public AgentId getFrom()
```
  - getTo
```
public AgentId getTo()
```
  - getNot
```
public Notification getNot()
```
  - toString
```
public String toString()
```
    Returns a string representation for this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
  - appendToString
```
public StringBuffer appendToString(StringBuffer strbuf)
```
    Adds a string representation for this object in the StringBuffer parameter.
    
    Parameters:
    
    strbuf - the String buffer to append.
    
    Returns:
    
    A string representation of this object.
  - optToByte
```
byte optToByte()
```
  - optFromByte
```
void optFromByte(byte opt)
```
  - writeObject
```
private void writeObject(ObjectOutputStream out)
                  throws IOException
```
    The writeObject method is responsible for writing the state of the object for its particular class so that the corresponding readObject method can restore it. Be careful this method should only be used for saving messages in persistent storage, sending messages will be done by another way. It is also used for HA synchronization.
    
    Parameters:
    
    out - The output stream.
    
    Throws:
    
    IOException - an error occurs.
  - readObject
```
private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
```
    The readObject method is responsible for reading from the stream and restoring the classes fields. Be careful this method should only be used for restoring messages from persistent storage, receiving messages will be done by another way.
    
    Parameters:
    
    in - The input stream.
    
    Throws:
    
    IOException - an error occurs.
    
    ClassNotFoundException - an error occurs.
  - toStringId
```
final String toStringId()
```
  - isPersistent
```
public boolean isPersistent()
```
    Tests if the associated notification is persistent or not.
    
    Returns:
    
    true if the associated notification is persistent.
  - save
```
void save()
   throws IOException
```
    Saves the object state on persistent storage.
    
    Throws:
    
    IOException - an error occurs.
  - load
```
static Message load(String name)
             throws IOException,
                    ClassNotFoundException
```
    Restores the object state from the persistent storage.
    
    Parameters:
    
    name - the persistent message name.
    
    Returns:
    
    the loaded message.
    
    Throws:
    
    IOException - when accessing the stored image
    
    ClassNotFoundException - if the stored image class may not be found
  - delete
```
void delete()
```
    Deletes the current object in persistent storage.
  - alloc
```
static Message alloc()
```
    Allocates a message from the pool.
    
    Returns:
    
    the allocated message.
  - alloc
```
static Message alloc(AgentId from,
                     AgentId to,
                     Notification not)
```
    Allocates a message from the pool.
    
    Parameters:
    
    from - id of source Agent.
    
    to - id of destination Agent.
    
    not - Notification to be signaled.
    
    Returns:
    
    the allocated message.
  - free
```
void free()
```
    Frees the message to the pool.
  - set
```
private void set(AgentId from,
                 AgentId to,
                 Notification not)
```
  - getEncodableClassId
```
public int getEncodableClassId()
```
    Description copied from interface: Encodable
    
    Returns a unique class identifier.
    
    Specified by:
    
    getEncodableClassId in interface Encodable
    
    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
    
    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
    
    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
    
    Parameters:
    
    decoder - the decoder to be used for the decoding
    
    Throws:
    
    Exception - if an error occurs

Class Message

Nested Class Summary

Field Summary

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

logger

DEBUG

from

to

not

source

dest

stamp

LENGTH

NULL

NOTNULL

PERSISTENT

DETACHABLE

stringId

pool

serializedNot

Constructor Detail

Message

Method Detail

getSource

getDest

getStamp

getFrom

getTo

getNot

toString

appendToString

optToByte

optFromByte

writeObject

readObject

toStringId

isPersistent

save

load

delete

alloc

alloc

free

set

getEncodableClassId

getEncodedSize

encode

decode