mam.agent
Class Agent

java.lang.Object
  |
  +--java.lang.Thread
        |
        +--mam.agent.Agent

Direct Known Subclasses:

AnalyzeAgent, MonitorAgent, OddAgent, TransactionalAgent, UrlKnowledgeAgent, WebServerAgent

public class Agent

extends Thread

implements MessageReceiver, Serializable, XmlSerializable

Basic Agent class Implements the necessary Agent interface messages from that interface.

Author:

nideffer

created November 25, 2001

Constructor Summary

Agent()           Constructor for the Agent object

Agent(Facility facility, AgentProperties defaultAgentProperties)           Constructor for the Agent object

Method Summary
synchronized void	enqueueMessage(AgentMessage incomingMessage)           Description of the Method
void	fromXmlElement(Element source)           Description of the Method
AccessStatisticsGroup	getAccessStatisticsGroup()           Gets the AccessStatisticsGroup attribute of the Agent object
Account	getAccount()           Gets the Account attribute of the Agent object
AgentProperties	getAgentProperties()           Gets the AgentProperties attribute of the Agent object
AgentTraits	getAgentTraits()           Gets the AgentTraits attribute of the Agent object
String	getDescription()           Gets the Description attribute of the Agent object
protected Facility	getFacility()           Gets the Facility attribute of the Agent object
MamId	getMamId()           Gets the MamId attribute of the Agent object
String	getNickname()           Gets the Nickname attribute of the Agent object
String	getQuote()           Gets the Quote attribute of the Agent object
String	getRole()           Gets the Role attribute of the Agent object
RoutingTag	getRoutingTagToSelf()           Gets the RoutingTagToSelf attribute of the Agent object
boolean	getXmlSerializable()           Gets the XmlSerializable attribute of the Agent object
void	handleDoAgentShutdownMessage(AgentMessage m)           Description of the Method
void	handleGetAccessStatisticsMessage(AgentMessage m)           Description of the Method
void	handleGetAgentPropertiesMessage(AgentMessage m)           Description of the Method
void	handleGetAgentTraitsMessage(AgentMessage m)           Message Handling notes: For some reason, the reflection mechanism fails when dealing with protected methods.
void	handleGetQuoteMessage(AgentMessage m)           Description of the Method
protected void	handleMessages()           Generic message handler Override this method to provide custom message handling.
void	handleSetDescriptionMessage(AgentMessage m)           Description of the Method
void	handleSetNicknameMessage(AgentMessage m)           Description of the Method
protected void	idleActivity()           Description of the Method
protected void	invokeMessageHandler(AgentMessage message)           Utility method to use reflection to invoke the standard handler for whatever message is passed.
protected void	registerRoutingTags()           Description of the Method
boolean	requiresPersistence()           Description of the Method
void	run()           A basic message handling loop.
void	setAccount(Account account)           Sets the Account attribute of the Agent object
void	setAgentTraits(AgentTraits agentTraits)           Sets the AgentTraits attribute of the Agent object
void	setDescription(String description)           Sets the Description attribute of the Agent object
void	setFacility(Facility localFacility)           Sets the Facility attribute of the Agent object
void	setMamId(MamId newMamId)           Sets the MamId attribute of the Agent object
void	setNickname(String nickname)           Sets the Nickname attribute of the Agent object
void	setRole(String role)           Sets the Role attribute of the Agent object
protected void	setXmlSerializable(boolean xmlSerializable)           Sets the XmlSerializable attribute of the Agent object
String	toString()           Description of the Method
Element	toXmlElement()           Description of the Method
Element	toXmlElement(String tagName)           Description of the Method
protected void	unregisterRoutingTags()           Description of the Method

Methods inherited from class java.lang.Thread

currentThread, yield, sleep, sleep, start, stop, stop, interrupt, interrupted, isInterrupted, destroy, isAlive, suspend, resume, setPriority, getPriority, setName, getName, getThreadGroup, activeCount, enumerate, countStackFrames, join, join, join, dumpStack, setDaemon, isDaemon, checkAccess, getContextClassLoader, setContextClassLoader

Methods inherited from class java.lang.Object

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

Field Detail

AGENT_ACCESS_STATISTICS_TAG_NAME

public final static String AGENT_ACCESS_STATISTICS_TAG_NAME

public final static String AGENT_PROPERTIES_TAG_NAME

public final static String AGENT_TRAITS_TAG_NAME

public final static RoutingTag ALL_AGENTS_ROUTING_TAG

public final static String DEFAULT_TAG_NAME

protected AccessStatisticsGroup m_accessStatisticsGroup

protected AgentProperties m_agentProperties

protected Facility m_facility

protected MessageQueue m_incomingMessageQueue

protected boolean m_shutdown

protected SleepManager m_sleepManager

private boolean m_xmlSerializable

public final static String ROLE_TAG_NAME

public Agent()

Constructor for the Agent object

Since:

public Agent(Facility facility, AgentProperties defaultAgentProperties)

Constructor for the Agent object

Parameters:

facility - Description of Parameter

defaultAgentProperties - Description of Parameter

Since:

public synchronized void enqueueMessage(AgentMessage incomingMessage)

Description of the Method

Parameters:

incomingMessage - Description of Parameter

Since:

public void fromXmlElement(Element source)

Description of the Method

Parameters:

source - Description of Parameter

Since:

public AccessStatisticsGroup getAccessStatisticsGroup()

Gets the AccessStatisticsGroup attribute of the Agent object

Returns: The AccessStatisticsGroup value

Since:

public Account getAccount()

Gets the Account attribute of the Agent object

Returns: The Account value

Since:

public AgentProperties getAgentProperties()

Gets the AgentProperties attribute of the Agent object

Returns: The AgentProperties value

Since:

public AgentTraits getAgentTraits()

Gets the AgentTraits attribute of the Agent object

Returns: The AgentTraits value

Since:

public String getDescription()

Gets the Description attribute of the Agent object

Returns: The Description value

Since:

protected Facility getFacility()

Gets the Facility attribute of the Agent object

Returns: The Facility value

Since:

public MamId getMamId()

Gets the MamId attribute of the Agent object

Returns: The MamId value

Since:

public String getNickname()

Gets the Nickname attribute of the Agent object

Returns: The Nickname value

Since:

public String getQuote()

Gets the Quote attribute of the Agent object

Returns: The Quote value

Since:

public String getRole()

Gets the Role attribute of the Agent object

Returns: The Role value

Since:

public RoutingTag getRoutingTagToSelf()

Gets the RoutingTagToSelf attribute of the Agent object

Returns: The RoutingTagToSelf value

Since:

public boolean getXmlSerializable()

Gets the XmlSerializable attribute of the Agent object

Returns: The XmlSerializable value

Since:

public void handleDoAgentShutdownMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleGetAccessStatisticsMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleGetAgentPropertiesMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleGetAgentTraitsMessage(AgentMessage m)

Message Handling notes: For some reason, the reflection mechanism fails when dealing with protected methods. Therefore, all the basic messages must be public in order to let descendents use them. Not sure why this is happening... will look into it.

Parameters:

m - Description of Parameter

Since:

public void handleGetQuoteMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

protected void handleMessages()

Generic message handler Override this method to provide custom message handling. Default is to handle messages one at a time, in the order they come in. Send an error message if you don't know how to handle a given message.

Since:

public void handleSetDescriptionMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleSetNicknameMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

protected void idleActivity()

Description of the Method

Since:

protected void invokeMessageHandler(AgentMessage message)
                              throws java.lang.Exception

Utility method to use reflection to invoke the standard handler for whatever message is passed.

Parameters:

message - Description of Parameter

Throws:

Exception - Description of Exception

Since:

protected void registerRoutingTags()

Description of the Method

Since:

public boolean requiresPersistence()

Description of the Method

Returns: Description of the Returned Value

Since:

public void run()

A basic message handling loop. All it does is sit and listen for messages, and then respond to each message it gets. Shuts down when the NMS does.

Since:

public void setAccount(Account account)

Sets the Account attribute of the Agent object

Parameters:

account - The new Account value

Since:

public void setAgentTraits(AgentTraits agentTraits)

Sets the AgentTraits attribute of the Agent object

Parameters:

agentTraits - The new AgentTraits value

Since:

public void setDescription(String description)

Sets the Description attribute of the Agent object

Parameters:

description - The new Description value

Since:

public void setFacility(Facility localFacility)

Sets the Facility attribute of the Agent object

Parameters:

localFacility - The new Facility value

Since:

public void setMamId(MamId newMamId)

Sets the MamId attribute of the Agent object

Parameters:

newMamId - The new MamId value

Since:

public void setNickname(String nickname)

Sets the Nickname attribute of the Agent object

Parameters:

nickname - The new Nickname value

Since:

public void setRole(String role)

Sets the Role attribute of the Agent object

Parameters:

role - The new Role value

Since:

protected void setXmlSerializable(boolean xmlSerializable)

Sets the XmlSerializable attribute of the Agent object

Parameters:

xmlSerializable - The new XmlSerializable value

Since:

public String toString()

Description of the Method

Returns: Description of the Returned Value

Since:

public Element toXmlElement()

Description of the Method

Returns: Description of the Returned Value

Since:

public Element toXmlElement(String tagName)

Description of the Method

Parameters:

tagName - Description of Parameter

Returns: Description of the Returned Value

Since:

protected void unregisterRoutingTags()

Description of the Method

Since: