org.arl.fjage

Class Message

java.lang.Object

org.arl.fjage.Message

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GenericMessage, GetFileReq, GetFileRsp, ParameterReq, ParameterRsp, PutFileReq, ShellExecReq

public class Message
extends java.lang.Object
implements java.io.Serializable

Base class for messages transmitted by one agent to another. This class provides the basic attributes of messages and is typically extended by application-specific message classes. To ensure that messages can be sent between agents running on remote containers, all attributes of a message must be serializable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	inReplyTo
protected java.lang.String	msgID
protected Performative	perf
protected AgentID	recipient
protected AgentID	sender
protected java.lang.Long	sentAt

Constructor Summary

Constructors

Constructor and Description
Message() Creates an empty message.
Message(AgentID recipient) Creates a new message.
Message(AgentID recipient, Performative perf) Creates a new message.
Message(Message inReplyTo) Creates a response message.
Message(Message inReplyTo, Performative perf) Creates a response message.
Message(Performative perf) Creates a new message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInReplyTo() Gets the message id of the associated request message.
java.lang.String	getJsonCache() Gets the Cached JSON String (if any)
java.lang.String	getMessageID() Gets the unique identifier for this message.
Performative	getPerformative() Gets the performative for this message.
AgentID	getRecipient() Gets the recipient of this message.
AgentID	getSender() Gets the sender of this message.
java.lang.Long	getSentAt() Gets the timestamp (milliseconds since epoch) that this message was sent at.
void	setInReplyTo(java.lang.String id) Sets the message id of the associated request message.
void	setJsonCache(java.lang.String _jsoncache) Sets the Cached JSON String
void	setMessageID(java.lang.String id) Sets the unique identifier for this message.
void	setPerformative(Performative perf) Sets the performative for this message.
void	setRecipient(AgentID aid) Sets the recipient of this message.
void	setSender(AgentID aid) Sets the sender of this message.
void	setSentAt(long ms) Sets the timestamp (milliseconds since epoch) that this message was sent at.
java.lang.String	toString() Gets a string representation of the message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

msgID

protected java.lang.String msgID

perf

protected Performative perf

recipient

protected AgentID recipient

sender

protected AgentID sender

inReplyTo

protected java.lang.String inReplyTo

sentAt

protected java.lang.Long sentAt

Constructor Detail

Message

public Message()

Creates an empty message.

Message

public Message(Performative perf)

Creates a new message.

Parameters:

perf - performative.

Message

public Message(AgentID recipient)

Creates a new message.

Parameters:

recipient - agent id of recipient agent or topic.

Message

public Message(AgentID recipient,
               Performative perf)

Creates a new message.

Parameters:

recipient - agent id of recipient agent or topic.

perf - performative.

Message

public Message(Message inReplyTo)

Creates a response message.

Parameters:

inReplyTo - message to which this response corresponds to.

Message

public Message(Message inReplyTo,
               Performative perf)

Creates a response message.

Parameters:

inReplyTo - message to which this response corresponds to.

perf - performative.

Method Detail

setPerformative

public void setPerformative(Performative perf)

Sets the performative for this message.

Parameters:

perf - performative.

getPerformative

public Performative getPerformative()

Gets the performative for this message.

Returns:

performative.

setRecipient

public void setRecipient(AgentID aid)

Sets the recipient of this message.

Parameters:

aid - recipient agent id.

getRecipient

public AgentID getRecipient()

Gets the recipient of this message.

Returns:

recipient agent id.

setSender

public void setSender(AgentID aid)

Sets the sender of this message.

Parameters:

aid - sender agent id.

getSender

public AgentID getSender()

Gets the sender of this message.

Returns:

sender agent id.

setMessageID

public void setMessageID(java.lang.String id)

Sets the unique identifier for this message.

Parameters:

id - message identifier.

getMessageID

public java.lang.String getMessageID()

Gets the unique identifier for this message.

Returns:

message identifier.

setInReplyTo

public void setInReplyTo(java.lang.String id)

Sets the message id of the associated request message.

Parameters:

id - message id of request message.

getInReplyTo

public java.lang.String getInReplyTo()

Gets the message id of the associated request message.

Returns:

message id of request message, null if this is not a response.

setSentAt

public void setSentAt(long ms)

Sets the timestamp (milliseconds since epoch) that this message was sent at.

Parameters:

ms - timestamp in milliseconds

getSentAt

public java.lang.Long getSentAt()

Gets the timestamp (milliseconds since epoch) that this message was sent at.

Returns:

timestamp in milliseconds, or null if unknown

getJsonCache

public java.lang.String getJsonCache()

Gets the Cached JSON String (if any)

Returns:

Cached JSON String representation of the message

setJsonCache

public void setJsonCache(java.lang.String _jsoncache)

Sets the Cached JSON String

Parameters:

_jsoncache - JSON String representation of the message

toString

public java.lang.String toString()

Gets a string representation of the message.

Overrides:

toString in class java.lang.Object

Returns:

string representation.

See Also:

Object.toString()