jade.core.behaviours

Class ActionExecutor<ActionT extends AgentAction,ResultT>

java.lang.Object

jade.core.behaviours.Behaviour

jade.core.behaviours.CompositeBehaviour

jade.core.behaviours.SerialBehaviour

jade.core.behaviours.FSMBehaviour

jade.proto.AchieveREInitiator

jade.core.behaviours.BaseInitiator

jade.core.behaviours.ActionExecutor<ActionT,ResultT>

Type Parameters:

ActionT - The class of the action to be executed

ResultT - The class of the result or Void if the action is not expected to return any result

All Implemented Interfaces:

java.io.Serializable

public class ActionExecutor<ActionT extends AgentAction,ResultT>
extends BaseInitiator

Base class for behaviours intended to request the execution of an action to a given actor and get back the result (if any)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionT	action
protected AID	actor
protected java.lang.String	conversationId
protected java.lang.String	language
protected Ontology	ontology
protected ResultT	result
protected long	timeout

Fields inherited from class jade.core.behaviours.BaseInitiator

conversations, myLogger, outcome

Fields inherited from class jade.proto.AchieveREInitiator

ALL_REQUESTS_KEY, ALL_RESPONSES_KEY, ALL_RESULT_NOTIFICATIONS_KEY, CHECK_AGAIN, HANDLE_AGREE, HANDLE_ALL_RESPONSES, HANDLE_ALL_RESULT_NOTIFICATIONS, HANDLE_INFORM, HANDLE_REFUSE, REPLY_KEY, REQUEST_KEY

Fields inherited from class jade.core.behaviours.FSMBehaviour

currentName, lastStates

Fields inherited from class jade.core.behaviours.Behaviour

myAgent

Constructor Summary

Constructors

Constructor and Description
ActionExecutor(ActionT action, Ontology ontology, AID actor)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createConvId(java.util.Vector msgs) Create a new conversation identifier to begin a new interaction.
protected ACLMessage	createInitiation() Concrete subclasses are expected to implement this method to create the initiation message.
protected ResultT	extractResult(Result r)
AID	getActualActor()
ResultT	getResult()
void	handleInform(ACLMessage inform) This method is called every time a inform message is received, which is not out-of-sequence according to the protocol rules.
protected void	handleOutOfSequence(ACLMessage msg) This method is called every time a message is received, which is out-of-sequence according to the protocol rules.
void	onStart() Override the onStart() method to initialize the vectors that will keep all the replies in the data store.
void	registerHandleFailure(Behaviour b) This method allows to register a user defined Behaviour in the HANDLE_FAILURE state.
void	registerHandleNotUnderstood(Behaviour b) This method allows to register a user defined Behaviour in the HANDLE_NOT_UNDERSTOOD state.
void	registerHandleOutOfSequence(Behaviour b) This method allows to register a user defined Behaviour in the HANDLE_OUT_OF_SEQ state.
void	reset() reset this behaviour by putting a null ACLMessage as message to be sent
void	reset(ACLMessage msg) reset this behaviour
protected AID	retrieveActor()
void	setAction(ActionT action)
void	setActor(AID actor)
void	setConversationId(java.lang.String conversationId)
void	setDataStore(DataStore ds) Override the setDataStore() method to propagate this setting to all children.
void	setLanguage(java.lang.String language)
void	setOntology(Ontology ontology)
void	setTimeout(long timeout)

Methods inherited from class jade.core.behaviours.BaseInitiator

checkLanguage, checkOntology, getErrorMsg, getExitCode, getOutcome, getTargetDescription, handleAllResultNotifications, handleFailure, handleNotUnderstood, handleRefuse, handleTimeout, onEnd, prepareRequests, setActiveConversations

Methods inherited from class jade.proto.AchieveREInitiator

getSession, handleAgree, handleAllResponses, registerHandleAgree, registerHandleAllResponses, registerHandleAllResultNotifications, registerHandleInform, registerHandleRefuse, registerPrepareRequests, reinit

Methods inherited from class jade.core.behaviours.FSMBehaviour

checkTermination, deregisterDefaultTransition, deregisterState, deregisterTransition, forceTransitionTo, getChildren, getCurrent, getLastExitValue, getName, getPrevious, getState, handleInconsistentFSM, handleStateEntered, hasDefaultTransition, registerDefaultTransition, registerDefaultTransition, registerFirstState, registerLastState, registerState, registerTransition, registerTransition, resetStates, scheduleFirst, scheduleNext, stringifyTransitionTable

Methods inherited from class jade.core.behaviours.CompositeBehaviour

action, done, resetChildren, setAgent

Methods inherited from class jade.core.behaviours.Behaviour

block, block, getAgent, getBehaviourName, getDataStore, getParent, isRunnable, restart, root, setBehaviourName

Methods inherited from class java.lang.Object

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

Field Detail

action

protected ActionT extends AgentAction action

result

protected ResultT result

actor

protected AID actor

language

protected java.lang.String language

ontology

protected Ontology ontology

timeout

protected long timeout

conversationId

protected java.lang.String conversationId

Constructor Detail

ActionExecutor

public ActionExecutor(ActionT action,
                      Ontology ontology,
                      AID actor)

Method Detail

setAction

public void setAction(ActionT action)

setActor

public void setActor(AID actor)

setOntology

public void setOntology(Ontology ontology)

setLanguage

public void setLanguage(java.lang.String language)

setTimeout

public void setTimeout(long timeout)

setConversationId

public void setConversationId(java.lang.String conversationId)

getResult

public ResultT getResult()

getActualActor

public AID getActualActor()

retrieveActor

protected AID retrieveActor()
                     throws FIPAException

Throws:

FIPAException

createInitiation

protected ACLMessage createInitiation()

Description copied from class: BaseInitiator

Concrete subclasses are expected to implement this method to create the initiation message.

Specified by:

createInitiation in class BaseInitiator

Returns:

The initiation message used by this behaviour

handleInform

public void handleInform(ACLMessage inform)

Description copied from class: AchieveREInitiator

This method is called every time a inform message is received, which is not out-of-sequence according to the protocol rules. This default implementation does nothing; programmers might wish to override the method in case they need to react to this event.

Overrides:

handleInform in class AchieveREInitiator

Parameters:

inform - the received inform message

extractResult

protected ResultT extractResult(Result r)

handleOutOfSequence

protected void handleOutOfSequence(ACLMessage msg)

This method is called every time a message is received, which is out-of-sequence according to the protocol rules. This default implementation does nothing; programmers might wish to override the method in case they need to react to this event.

Parameters:

msg - the received message

registerHandleNotUnderstood

public void registerHandleNotUnderstood(Behaviour b)

This method allows to register a user defined Behaviour in the HANDLE_NOT_UNDERSTOOD state. This behaviour would override the homonymous method. This method also set the data store of the registered Behaviour to the DataStore of this current behaviour. The registered behaviour can retrieve the not-understood ACLMessage object received from the datastore at the REPLY_KEY key.

Parameters:

b - the Behaviour that will handle this state

registerHandleFailure

public void registerHandleFailure(Behaviour b)

This method allows to register a user defined Behaviour in the HANDLE_FAILURE state. This behaviour would override the homonymous method. This method also set the data store of the registered Behaviour to the DataStore of this current behaviour. The registered behaviour can retrieve the failure ACLMessage object received from the datastore at the REPLY_KEY key.

Parameters:

b - the Behaviour that will handle this state

registerHandleOutOfSequence

public void registerHandleOutOfSequence(Behaviour b)

This method allows to register a user defined Behaviour in the HANDLE_OUT_OF_SEQ state. This behaviour would override the homonymous method. This method also set the data store of the registered Behaviour to the DataStore of this current behaviour. The registered behaviour can retrieve the out of sequence ACLMessage object received from the datastore at the REPLY_KEY key.

Parameters:

b - the Behaviour that will handle this state

reset

public void reset()

reset this behaviour by putting a null ACLMessage as message to be sent

Overrides:

reset in class FSMBehaviour

reset

public void reset(ACLMessage msg)

reset this behaviour

Parameters:

msg - is the ACLMessage to be sent

onStart

public void onStart()

Override the onStart() method to initialize the vectors that will keep all the replies in the data store.

Overrides:

onStart in class Behaviour

setDataStore

public void setDataStore(DataStore ds)

Override the setDataStore() method to propagate this setting to all children.

Overrides:

setDataStore in class Behaviour

Parameters:

ds - the DataStore that this Behaviour will use as its private data store

createConvId

protected java.lang.String createConvId(java.util.Vector msgs)

Create a new conversation identifier to begin a new interaction.

Parameters:

msgs - A vector of ACL messages. If the first one has a non-empty :conversation-id slot, its value is used, else a new conversation identifier is generated.