| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class provides a representation of the FIPA99/2000 envelope (implements XC00067C)
In conformance with the FIPA99/2000 specification slots cannot be overwriten, just overridden.
Constructor Summary | |
Envelope() Default constructor - creates an empty envelope | |
Envelope(ACL msg) Creates an Envelope based upon the given ACL object |
Method Summary | |
void | addMessageListener(MessageListener ml) Add a MessageListener to this |
Object | clone() |
Object | cloneSlot(Object slot) Attempt to clone a value that has been inserted into a slot |
String | getACLRepresentation() Gets the ACL representation associated with this envelope |
String | getComments() Gets the comments associated with this Envelope |
UTCTime | getDate() Gets the creating date of this Envelope |
List | getEncrypted() Gets details of the encryption used on the content of the envelope |
int | getErrorCode() Get the internal error condition for this envelope N.B. |
List | getIntendedReceiver() Gets the intended receivers for the message |
List | getMessageListeners() Get list of MessageListeners |
String | getPayloadEncoding() Gets the payload encoding associated with this Envelope |
int | getPayloadLength() Gets the payload length associated with this Envelope |
Received | getReceived() Gets details of when the message was received by an entity |
List | getReceivers() Gets a List of the recipients' AID's |
AgentID | getSender() Gets the sender of the message |
synchronized Object | getSlotValue(String slot) Generic method for retreiving the value assigned to a slot within the envelope |
synchronized Envelope | getSubEnvelope(int x) Gets a particular sub-envelope |
synchronized List | getSubEnvelopes() Returns a list of the sub-envelopes composing this |
TransportBehaviour | getTransportBehaviour() Gets the TransportBehviour parameter |
List | getTransportsTried() Returns the transports that have been tried whilst attempting to send this message |
List | getUnknownURLsTried() Returns the URL's that have been tried, but an MTP implementation hasn't been found |
synchronized Set | getUserSlots() Returns a list of the names of non-standard slots contained within this Envelope |
boolean | getViaACC() Indicates if this should be routed via the ACC |
static void | main(String[] args) Test-harness |
synchronized void | newSubEnvelope() Indicates that a new sub-envelope should be started (i.e. |
void | removeMessageListener(MessageListener ml) Remove a MessageListener from this |
void | setACLRepresentation(String type) Sets the ACL representation of this Envelope |
void | setComments(String comments) Sets the comments associated with this envelope |
void | setDate(UTCTime utc) Sets the date of creation for this envelope |
void | setEncrypted(List enc) Sets details of the encryption used on the content of the envelope |
void | setErrorCode(int code) Set the internal error condition for this envelope N.B. |
void | setIntendedReceiver(List aids) Sets the intended receivers for the message |
void | setPayloadEncoding(String encoding) Sets the payload encoding associated with this envelope |
void | setPayloadLength(int length) Sets the payload length associated with this envelope |
void | setReceived(Received received) Sets details of when the message was received by an entity |
void | setReceivers(List aids) Sets the list of receivers for the message |
void | setSender(AgentID aid) Sets the sender of the message |
synchronized void | setSlotValue(String slot, Object value) Generic method for adding a value to a slot within the envelope |
void | setTransportBehaviour(TransportBehaviour behaviour) Sets the TransportBehviour parameter |
void | setViaACC(boolean value) Sets the flag that indicates if the message this encapsulates should be routed via the ACC |
String | toString() Overrides default toString() method - displays contents of Envelope |
Constructor Detail |
public Envelope()
public Envelope(ACL msg)
Method Detail |
public void addMessageListener(MessageListener ml)
public Object clone()
public Object cloneSlot(Object slot)
public String getACLRepresentation()
public String getComments()
public UTCTime getDate()
public List getEncrypted()
public int getErrorCode()
N.B. This is not part of the FIPA specification, but servers as a mechanism for "tagging" messages with "exception" codes at the transport layer
public List getIntendedReceiver()
public List getMessageListeners()
public String getPayloadEncoding()
public int getPayloadLength()
public Received getReceived()
public List getReceivers()
public AgentID getSender()
public synchronized Object getSlotValue(String slot)
public synchronized Envelope getSubEnvelope(int x)
public synchronized List getSubEnvelopes()
public TransportBehaviour getTransportBehaviour()
public List getTransportsTried()
public List getUnknownURLsTried()
public synchronized Set getUserSlots()
public boolean getViaACC()
public static void main(String[] args)
public synchronized void newSubEnvelope()
public void removeMessageListener(MessageListener ml)
public void setACLRepresentation(String type)
public void setComments(String comments)
public void setDate(UTCTime utc)
public void setEncrypted(List enc)
public void setErrorCode(int code)
Set the internal error condition for this envelope
N.B. This is not part of the FIPA specification, but servers as a mechanism for "tagging" messages with "exception" codes at the transport layer
public void setIntendedReceiver(List aids)
public void setPayloadEncoding(String encoding)
public void setPayloadLength(int length)
public void setReceived(Received received)
public void setReceivers(List aids)
public void setSender(AgentID aid)
public synchronized void setSlotValue(String slot, Object value)
public void setTransportBehaviour(TransportBehaviour behaviour)
public void setViaACC(boolean value)
public String toString()
Association Links |
to Class java.util.Map
to Class java.util.List
to Class fipaos.ont.fipa.fipaman.Envelope
to Class fipaos.ont.fipa.fipaman.Envelope
to Class java.util.List
to Class java.util.List
to Class java.util.List
| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |