Package fr.dyade.aaa.agent

Class AgentEngineContextImpl

java.lang.Object

fr.dyade.aaa.agent.AgentEngineContextImpl

All Implemented Interfaces:

AgentEngineContext

class AgentEngineContextImpl
extends Object
implements AgentEngineContext

Context enabling an AgentEngine implemented in another package to invoke operations that cannot be accessed outside of the fr.dyade.aaa.agent package. An AgentEngineContext should be for the unique private use of its associated AgentEngine and should not be shared with any other components otherwise the agent server security would be broken.

Field Summary

Fields

Modifier and Type	Field	Description
private static EncodableFactory	messageFactory

Constructor Summary

Constructors

Constructor	Description
AgentEngineContextImpl()	Package constructor not accessible from outside this package.

Method Summary

Modifier and Type	Method	Description
void	channelPost(Message msg)	Posts a message in the channel.
void	checkMessageFrom(Message msg)	Checks the message 'from'.
Agent	createAgentFactory()	Creates an instance of AgentFactory.
Message	createMessage(AgentId from, AgentId to, Notification not)	Creates a message.
void	deleteMessage(Message msg)	Deletes and frees the specified message.
void	directSendTo(AgentId to, Notification not)	Sends a notification to the specified destination with a local id.
MessageConsumer	getConsumer(short id)	Returns the specified MessageConsumer
AgentId	getLocalAgentId()	Returns the local agent id.
void	incReactNumber(Agent ag)	Increments the reaction counter of the specified agent.
void	initAgentLogger(Agent agent)	Initializes the agent's logger.
void	initializeAgent(AgentId id, Agent agent)	Initializes an agent after creation.
void	initializeReloadedAgent(Agent agent)	Initializes a reloaded agent.
Agent	loadAgent(AgentId id)	Loads the specified agent.
void	saveAgent(Agent agent)	Saves the agent
void	saveChannel()	Saves the channel
void	setAgentLast(Agent ag, long last)	Sets the agent last reaction count.
void	setSaveAgent(Agent agent)	Sets the agent as to be saved.
void	stampAndSave(Message msg, int stamp)	Stamps and saves the specified message.
void	validateChannel()	Validates the Channel.

Methods inherited from class java.lang.Object

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

Field Detail

messageFactory

private static EncodableFactory messageFactory

Constructor Detail

AgentEngineContextImpl

AgentEngineContextImpl()

Package constructor not accessible from outside this package.

Method Detail

createAgentFactory

public Agent createAgentFactory()
                         throws IOException

Creates an instance of AgentFactory.

Specified by:

createAgentFactory in interface AgentEngineContext

Returns:

an instance of AgentFactory

Throws:

IOException - an error occurs.

initializeAgent

public void initializeAgent(AgentId id,
                            Agent agent)
                     throws Exception

Initializes an agent after creation. First time is true.

Specified by:

initializeAgent in interface AgentEngineContext

Parameters:

id - the identifier of the agent to initialize

agent - the agent to initialize

Throws:

Exception - an error occurs.

directSendTo

public void directSendTo(AgentId to,
                         Notification not)

Sends a notification to the specified destination with a local id.

Specified by:

directSendTo in interface AgentEngineContext

Parameters:

to - the notification destination

not - the notification to send

initAgentLogger

public void initAgentLogger(Agent agent)
                     throws Exception

Initializes the agent's logger.

Specified by:

initAgentLogger in interface AgentEngineContext

Parameters:

agent - the agent to initialize

Throws:

Exception - an error occurs.

loadAgent

public Agent loadAgent(AgentId id)
                throws IOException,
                       ClassNotFoundException

Loads the specified agent.

Specified by:

loadAgent in interface AgentEngineContext

Parameters:

id - the identifier of the agent to load

Returns:

the loaded agent

Throws:

IOException - an error occurs.

ClassNotFoundException - an error occurs.

setAgentLast

public void setAgentLast(Agent ag,
                         long last)

Sets the agent last reaction count.

Specified by:

setAgentLast in interface AgentEngineContext

Parameters:

ag - the agent to modify

last - the reaction count to set

initializeReloadedAgent

public void initializeReloadedAgent(Agent agent)
                             throws Exception

Initializes a reloaded agent. First time is false.

Specified by:

initializeReloadedAgent in interface AgentEngineContext

Parameters:

agent - the agent to initialize.

Throws:

Exception - an error occurs.

setSaveAgent

public void setSaveAgent(Agent agent)

Sets the agent as to be saved.

Specified by:

setSaveAgent in interface AgentEngineContext

Parameters:

agent - the agent to update

saveAgent

public void saveAgent(Agent agent)
               throws IOException

Saves the agent

Specified by:

saveAgent in interface AgentEngineContext

Parameters:

agent - the agent to save

Throws:

IOException - an error occurs.

createMessage

public Message createMessage(AgentId from,
                             AgentId to,
                             Notification not)

Creates a message.

Specified by:

createMessage in interface AgentEngineContext

Parameters:

from - the source of the message

to - the destination of the message

not - the notification to be transmitted by the message

Returns:

the created message.

deleteMessage

public void deleteMessage(Message msg)

Deletes and frees the specified message.

Specified by:

deleteMessage in interface AgentEngineContext

Parameters:

msg - the message to delete.

getLocalAgentId

public AgentId getLocalAgentId()

Returns the local agent id.

Specified by:

getLocalAgentId in interface AgentEngineContext

Returns:

the local agent id

incReactNumber

public void incReactNumber(Agent ag)

Increments the reaction counter of the specified agent.

Specified by:

incReactNumber in interface AgentEngineContext

Parameters:

ag - the agent to update

validateChannel

public void validateChannel()

Validates the Channel.

Specified by:

validateChannel in interface AgentEngineContext

checkMessageFrom

public void checkMessageFrom(Message msg)

Checks the message 'from'.

Specified by:

checkMessageFrom in interface AgentEngineContext

Parameters:

msg - the message to check

getConsumer

public MessageConsumer getConsumer(short id)
                            throws UnknownServerException

Returns the specified MessageConsumer

Specified by:

getConsumer in interface AgentEngineContext

Parameters:

id - the identifier of the MessageConsumer

Returns:

the specified MessageConsumer

Throws:

UnknownServerException - the server is not defined.

channelPost

public void channelPost(Message msg)
                 throws Exception

Posts a message in the channel.

Specified by:

channelPost in interface AgentEngineContext

Parameters:

msg - the message to post

Throws:

Exception - an error occurs.

saveChannel

public void saveChannel()
                 throws IOException

Saves the channel

Specified by:

saveChannel in interface AgentEngineContext

Throws:

IOException - an error occurs.

stampAndSave

public void stampAndSave(Message msg,
                         int stamp)
                  throws IOException

Stamps and saves the specified message.

Specified by:

stampAndSave in interface AgentEngineContext

Parameters:

msg - the message to stamp and save

stamp - the stamp to assign

Throws:

IOException - an error occurs.