mam.messaging
Class AgentMessage

Direct Known Subclasses:
DeclareLocationKeywordsMessage, DoAddAgentMessage, DoAddIdentityMessage, DoAddListenerMessage, DoAddMonitoredUrlMessage, DoAdjustFundsMessage, DoAdjustTraitsMessage, DoAgentShutdownMessage, DoCreateAgentMessage, DoDestroyAgentMessage, DoEndCPActivityMessage, DoEndFSActivityMessage, DoEndMarketingMessage, DoEndMissionMessage, DoEndSIActivityMessage, DoExportToMooMessage, DoFacilityShutdownMessage, DoImgSwapMessage, DoLoginMessage, DoModifyTraitsMessage, DoMooCombatDeathMessage, DoMooCombatWimpoutMessage, DoPhatExitMessage, DoPopQuizMessage, DoProxyCreateMessage, DoQueryInformationPersonaeMessage, DoQueryKnowledgeMessage, DoQueryKnownAgentsMessage, DoQueryMessage, DoQueryMonitoredUrlsMessage, DoRandomizeTranslationMessage, DoRemoveAgentMessage, DoRemoveIdentityMessage, DoRemoveListenerMessage, DoRemoveMonitoredUrlMessage, DoRequestMarketingMessage, DoRestoreAgentTraitsMessage, DoRestoreTraitsMessage, DoRestoreTranslationMessage, DoSetIpAgentMessage, DoSetMonitorAgentMessage, DoShowMarketingTextMessage, DoStartCPActivityMessage, DoStartFSActivityMessage, DoStartMarketingMessage, DoStartMissionMessage, DoStartSIActivityMessage, DoStreamKnownAgentsMessage, DoStreamMonitoredUrlsMessage, EventAgentCreatedMessage, EventAgentDeathMessage, EventDeclareAccessStatisticsMessage, EventDeclareAgentPropertiesMessage, EventDeclareAgentTraitsMessage, EventDeclareAggregateTraitsMessage, EventDeclareFacilityShutdownMessage, EventDeclareKnowledgeAgentAddedMessage, EventDeclareKnowledgeAgentRemovedMessage, EventDoLoginResultsMessage, EventExportFinishedMessage, EventGl4JavaNotInstalledMessage, EventLinkDialogFinishedMessage, EventLocationChangedMessage, EventMonitoredUrlAddedMessage, EventMonitoredUrlRemovedMessage, EventMonitoredUrlUpdatedMessage, EventPopQuizResultsMessage, EventQueryCompleteMessage, EventQueryKnowledgeResultsMessage, EventQueryKnownAgentsResultsMessage, EventQueryMonitoredUrlsResultsMessage, EventQueryUpdateMessage, EventSecretAgentReportMessage, GetAccessStatisticsMessage, GetAgentPropertiesMessage, GetAgentTraitsMessage, GetAggregateTraitsMessage, GetKnowledgeMessage, GetMonitorAgentMessage, GetQuoteMessage, GetVisualizerNodesMessage, SetAgentTraitsMessage, SetDescriptionMessage, SetLoginInfoMessage, SetNicknameMessage

public abstract class AgentMessage
implements Serializable, XmlSerializable

Represents a message within the agent system. Messages are assumed to be immutable by any agent other than its creator. Altering a message should be accomplished by cloning it first, then changing it. Generally, destination tags should be conceptual spaces rather than exact locations. For example, send to "announcements-agent-general" rather than "agent 1000-200-3001".


Field Summary
 final static StringDEFAULT_TAG_NAME
           
 final static intDEFAULT_TIME_TO_LIVE
           
 final static StringDESTINATION_TAG_NAME
           
 protected Datem_attrCreationDate
           
 protected RoutingTagm_attrDestination
           
 protected MamIdm_attrId
           
 protected MamIdm_attrOriginFacility
           
 protected MamIdm_attrReplyTo
           
 protected MamIdm_attrResponseTo
           
 protected RoutingTagm_attrSource
           
 protected intm_attrTimeToLive
           
 final static StringSOURCE_TAG_NAME
           

Constructor Summary
 protected AgentMessage()
           
 protected AgentMessage(RoutingTag source, RoutingTag destination, MamId responseTo)
           
 protected AgentMessage(RoutingTag source, MamId replyTo, RoutingTag destination, MamId responseTo)
           

Method Summary
 voiddecrementTimeToLive()
           
 voidfromXmlElement(Element source)
           
 RoutingTaggetDestination()
           
 MamIdgetId()
           
 MamIdgetOriginFacility()
           
 intgetRemainingTimeToLive()
           
 MamIdgetReplyTo()
           
 MamIdgetResponseTo()
           
 RoutingTaggetSource()
           
 StringgetType()
           
 voidsetDestination(RoutingTag destination)
           
 voidsetId(MamId id)
           
 voidsetLocal()
           
 voidsetOriginFacility(MamId originFacility)
           
 voidsetReplyTo(MamId replyTo)
           
 voidsetResponseTo(MamId responseTo)
           
 voidsetSource(RoutingTag source)
           
 StringtoString()
           
 ElementtoXmlElement()
           
 ElementtoXmlElement(String tagName)
           

Field Detail

DEFAULT_TAG_NAME

public final static String DEFAULT_TAG_NAME

DEFAULT_TIME_TO_LIVE

public final static int DEFAULT_TIME_TO_LIVE

DESTINATION_TAG_NAME

public final static String DESTINATION_TAG_NAME

m_attrCreationDate

protected Date m_attrCreationDate

m_attrDestination

protected RoutingTag m_attrDestination

m_attrId

protected MamId m_attrId

m_attrOriginFacility

protected MamId m_attrOriginFacility

m_attrReplyTo

protected MamId m_attrReplyTo

m_attrResponseTo

protected MamId m_attrResponseTo

m_attrSource

protected RoutingTag m_attrSource

m_attrTimeToLive

protected int m_attrTimeToLive

SOURCE_TAG_NAME

public final static String SOURCE_TAG_NAME
Constructor Detail

AgentMessage

protected AgentMessage()

AgentMessage

protected AgentMessage(RoutingTag source, RoutingTag destination, MamId responseTo)

AgentMessage

protected AgentMessage(RoutingTag source, MamId replyTo, RoutingTag destination, MamId responseTo)
Method Detail

decrementTimeToLive

public void decrementTimeToLive()

fromXmlElement

public void fromXmlElement(Element source)

getDestination

public RoutingTag getDestination()

getId

public MamId getId()

getOriginFacility

public MamId getOriginFacility()

getRemainingTimeToLive

public int getRemainingTimeToLive()

getReplyTo

public MamId getReplyTo()

getResponseTo

public MamId getResponseTo()

getSource

public RoutingTag getSource()

getType

public String getType()

setDestination

public void setDestination(RoutingTag destination)

setId

public void setId(MamId id)

setLocal

public void setLocal()

setOriginFacility

public void setOriginFacility(MamId originFacility)

setReplyTo

public void setReplyTo(MamId replyTo)

setResponseTo

public void setResponseTo(MamId responseTo)

setSource

public void setSource(RoutingTag source)

toString

public String toString()

toXmlElement

public Element toXmlElement()

toXmlElement

public Element toXmlElement(String tagName)