Overview  Package   Class  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

sajas.proto
Class ProposeInitiator
java.lang.Object
  sajas.core.behaviours.Behaviour
      sajas.core.behaviours.CompositeBehaviour
          sajas.core.behaviours.SerialBehaviour
              sajas.core.behaviours.FSMBehaviour
                  sajas.proto.ProposeInitiator
All Implemented Interfaces:
jade.util.leap.Serializable, Serializable

public class ProposeInitiator
extends FSMBehaviour
Note: this class has been re-implemented to redirect the use of the agent, behaviour and protocol classes to SAJaS versions.
Author:
hlc
See Also:
jade.proto.ProposeInitiator

Nested classes/interfaces inherited from class sajas.core.behaviours.Behaviour
Behaviour.RunnableChangedEvent
Field Summary
protected String
ALL_INITIATIONS_K
          key to retrieve from the DataStore of the behaviour the vector of PROPOSE ACLMessage objects that have to be sent.
String
ALL_RESPONSES_KEY
          key to retrieve from the DataStore of the behaviour the vector of ACLMessage objects that have been received as responses.
protected static String
CHECK_IN_SEQ
protected static String
CHECK_SESSIONS
protected static String
DUMMY_FINAL
protected static String
HANDLE_ACCEPT_PROPOSAL
protected static String
HANDLE_ALL_RESPONSES
protected static String
HANDLE_NOT_UNDERSTOOD
protected static String
HANDLE_OUT_OF_SEQ
protected static String
HANDLE_REJECT_PROPOSAL
protected String
INITIATION_K
          key to retrieve from the DataStore of the behaviour the ACLMessage object passed in the constructor of the class.
protected static String
PREPARE_INITIATIONS
protected static String
RECEIVE_REPLY
String
REPLY_KEY
          key to retrieve from the DataStore of the behaviour the last ACLMessage object that has been received (null if the timeout expired).
protected MsgReceiver
replyReceiver
protected jade.lang.acl.MessageTemplate
replyTemplate
protected static String
SEND_INITIATIONS
protected jade.util.leap.Map
sessions
protected String[]
toBeReset
Fields inherited from class sajas.core.behaviours.FSMBehaviour
currentName, lastStates
Fields inherited from class sajas.core.behaviours.CompositeBehaviour
currentExecuted
Fields inherited from class sajas.core.behaviours.Behaviour
myAgent, myEvent, NOTIFY_DOWN, NOTIFY_UP, parent, STATE_BLOCKED, STATE_READY, STATE_RUNNING
Constructor Summary
ProposeInitiator(Agent a, jade.lang.acl.ACLMessage msg)
          Construct a ProposeInitiator with an empty DataStore
ProposeInitiator(Agent a, jade.lang.acl.ACLMessage initiation, DataStore store)
          Construct a ProposeInitiator with a given DataStore
Method Summary
protected void
adjustReplyTemplate(jade.lang.acl.ACLMessage msg)
protected boolean
checkInSequence(jade.lang.acl.ACLMessage reply)
          Check whether a reply is in-sequence and update the appropriate Session.
protected int
checkSessions(jade.lang.acl.ACLMessage reply)
          Check the status of the sessions after the reception of the last reply or the expiration of the timeout.
protected String
createConvId(Vector msgs)
          Create a new conversation identifier to begin a new interaction.
protected void
handleAcceptProposal(jade.lang.acl.ACLMessage accept_proposal)
          This method is called every time an accept-proposal message is received, which is not out-of-sequence according to the protocol rules.
protected void
handleAllResponses(Vector responses)
          This method is called when all the responses have been collected or when the timeout is expired.
protected void
handleNotUnderstood(jade.lang.acl.ACLMessage notUnderstood)
          This method is called every time a not-understood message is received, which is not out-of-sequence according to the protocol rules.
protected void
handleOutOfSequence(jade.lang.acl.ACLMessage msg)
          This method is called every time a message is received, which is out-of-sequence according to the protocol rules.
protected void
handleRejectProposal(jade.lang.acl.ACLMessage reject_proposal)
          This method is called every time an reject-proposal message is received, which is not out-of-sequence according to the protocol rules.
protected void
initializeDataStore(jade.lang.acl.ACLMessage msg)
          Initialize the data store.
void
onStart()
          Override the onStart() method to initialize the vectors that will keep all the replies in the data store.
protected Vector
prepareInitiations(jade.lang.acl.ACLMessage propose)
          This method must return the vector of ACLMessage objects to be sent.
void
registerHandleAcceptProposal(Behaviour b)
          This method allows to register a user defined Behaviour in the HANDLE_ACCEPT_PROPOSAL state.
void
registerHandleAllResponses(Behaviour b)
          This method allows to register a user defined Behaviour in the HANDLE_ALL_RESPONSES 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
registerHandleRejectProposal(Behaviour b)
          This method allows to register a user defined Behaviour in the HANDLE_REJECT_PROPOSAL state.
void
reset()
          reset this behaviour by putting a null ACLMessage as message to be sent
void
reset(jade.lang.acl.ACLMessage msg)
          reset this behaviour
protected void
sendInitiations(Vector initiations)
          Create and initialize the Sessions and sends the initiation messages.
void
setDataStore(DataStore ds)
          Override the setDataStore() method to initialize propagate this setting to all children.
Methods inherited from class sajas.core.behaviours.FSMBehaviour
checkTermination, deregisterDefaultTransition, deregisterState, deregisterTransition, forceTransitionTo, getChildren, getCurrent, getLastExitValue, getName, getPrevious, getState, handleInconsistentFSM, handleStateEntered, hasDefaultTransition, onEnd, registerDefaultTransition, registerDefaultTransition, registerFirstState, registerLastState, registerState, registerTransition, registerTransition, resetStates, scheduleFirst, scheduleNext, stringifyTransitionTable
Methods inherited from class sajas.core.behaviours.SerialBehaviour
handle
Methods inherited from class sajas.core.behaviours.CompositeBehaviour
action, done, handleBlockEvent, handleRestartEvent, registerAsChild, resetChildren, setAgent
Methods inherited from class sajas.core.behaviours.Behaviour
actionWrapper, block, block, getAgent, getBehaviourName, getDataStore, getExecutionState, getParent, getRestartCounter, isRunnable, restart, root, setBehaviourName, setExecutionState
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
ALL_INITIATIONS_K
protected final String ALL_INITIATIONS_K
key to retrieve from the DataStore of the behaviour the vector of PROPOSE ACLMessage objects that have to be sent.

ALL_RESPONSES_KEY
public final String ALL_RESPONSES_KEY
key to retrieve from the DataStore of the behaviour the vector of ACLMessage objects that have been received as responses.

CHECK_IN_SEQ
protected static final String CHECK_IN_SEQ
See Also:
Constant Field Values

CHECK_SESSIONS
protected static final String CHECK_SESSIONS
See Also:
Constant Field Values

DUMMY_FINAL
protected static final String DUMMY_FINAL
See Also:
Constant Field Values

HANDLE_ACCEPT_PROPOSAL
protected static final String HANDLE_ACCEPT_PROPOSAL
See Also:
Constant Field Values

HANDLE_ALL_RESPONSES
protected static final String HANDLE_ALL_RESPONSES
See Also:
Constant Field Values

HANDLE_NOT_UNDERSTOOD
protected static final String HANDLE_NOT_UNDERSTOOD
See Also:
Constant Field Values

HANDLE_OUT_OF_SEQ
protected static final String HANDLE_OUT_OF_SEQ
See Also:
Constant Field Values

HANDLE_REJECT_PROPOSAL
protected static final String HANDLE_REJECT_PROPOSAL
See Also:
Constant Field Values

INITIATION_K
protected final String INITIATION_K
key to retrieve from the DataStore of the behaviour the ACLMessage object passed in the constructor of the class.

PREPARE_INITIATIONS
protected static final String PREPARE_INITIATIONS
See Also:
Constant Field Values

RECEIVE_REPLY
protected static final String RECEIVE_REPLY
See Also:
Constant Field Values

REPLY_KEY
public final String REPLY_KEY
key to retrieve from the DataStore of the behaviour the last ACLMessage object that has been received (null if the timeout expired).

replyReceiver
protected MsgReceiver replyReceiver

replyTemplate
protected jade.lang.acl.MessageTemplate replyTemplate

SEND_INITIATIONS
protected static final String SEND_INITIATIONS
See Also:
Constant Field Values

sessions
protected jade.util.leap.Map sessions

toBeReset
protected String[] toBeReset
Constructor Detail
ProposeInitiator
public ProposeInitiator(Agent a,
                        jade.lang.acl.ACLMessage msg)
Construct a ProposeInitiator with an empty DataStore
See Also:
ProposeInitiator(Agent, ACLMessage, DataStore)

ProposeInitiator
public ProposeInitiator(Agent a,
                        jade.lang.acl.ACLMessage initiation,
                        DataStore store)
Construct a ProposeInitiator with a given DataStore
Parameters:
a - The agent performing the protocol
initiation - The message that must be used to initiate the protocol. Notice that the default implementation of the prepareInitiations() method returns an array composed of only this message. The values of the slot reply-with is ignored and a different value is assigned automatically by this class for each receiver.
store - The DataStore that will be used by this ProposeInitiator
Method Detail
initializeDataStore
protected void initializeDataStore(jade.lang.acl.ACLMessage msg)
Initialize the data store.

sendInitiations
protected void sendInitiations(Vector initiations)
Create and initialize the Sessions and sends the initiation messages. This method is called internally by the framework and is not intended to be called by the user

checkInSequence
protected boolean checkInSequence(jade.lang.acl.ACLMessage reply)
Check whether a reply is in-sequence and update the appropriate Session. This method is called internally by the framework and is not intended to be called by the user

checkSessions
protected int checkSessions(jade.lang.acl.ACLMessage reply)
Check the status of the sessions after the reception of the last reply or the expiration of the timeout. This method is called internally by the framework and is not intended to be called by the user

prepareInitiations
protected Vector prepareInitiations(jade.lang.acl.ACLMessage propose)
This method must return the vector of ACLMessage objects to be sent. It is called in the first state of this protocol. This default implementation just returns the ACLMessage object (a PROPOSE) passed in the constructor. Programmers might prefer to override this method in order to return a vector of PROPOSE objects for 1:N conversations or also to prepare the messages during the execution of the behaviour.
Parameters:
propose - the ACLMessage object passed in the constructor
Returns:
a Vector of ACLMessage objects. The value of the slot reply-with is ignored and regenerated automatically by this class.

handleAcceptProposal
protected void handleAcceptProposal(jade.lang.acl.ACLMessage accept_proposal)
This method is called every time an accept-proposal 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.
Parameters:
accept_proposal - the received accept-proposal message

handleRejectProposal
protected void handleRejectProposal(jade.lang.acl.ACLMessage reject_proposal)
This method is called every time an reject-proposal 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.
Parameters:
reject_proposal - the received reject-proposal message

handleNotUnderstood
protected void handleNotUnderstood(jade.lang.acl.ACLMessage notUnderstood)
This method is called every time a not-understood 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.
Parameters:
notUnderstood - the received not-understood message

handleOutOfSequence
protected void handleOutOfSequence(jade.lang.acl.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

registerHandleAllResponses
public void registerHandleAllResponses(Behaviour b)
This method allows to register a user defined Behaviour in the HANDLE_ALL_RESPONSES 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 vector of ACLMessage objects, received as a response, from the datastore at the ALL_RESPONSES_KEY key.
Parameters:
b - the Behaviour that will handle this state

registerHandleAcceptProposal
public void registerHandleAcceptProposal(Behaviour b)
This method allows to register a user defined Behaviour in the HANDLE_ACCEPT_PROPOSAL 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 inform ACLMessage object received from the datastore at the REPLY_KEY key.
Parameters:
b - the Behaviour that will handle this state

registerHandleRejectProposal
public void registerHandleRejectProposal(Behaviour b)
This method allows to register a user defined Behaviour in the HANDLE_REJECT_PROPOSAL 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 inform ACLMessage object received from the datastore at the REPLY_KEY key.
Parameters:
b - the Behaviour that will handle this state

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

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

handleAllResponses
protected void handleAllResponses(Vector responses)
This method is called when all the responses have been collected or when the timeout is expired. The used timeout is the minimum value of the slot replyBy of all the sent messages. By response message we intend here all the accept-proposal, reject-proposal, not-understood received messages, which are not 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 by analysing all the messages in just one call.
Parameters:
responses - the Vector of ACLMessage objects that have been received

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(jade.lang.acl.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 initialize 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 String createConvId(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.

adjustReplyTemplate
protected void adjustReplyTemplate(jade.lang.acl.ACLMessage msg)

Overview  Package   Class  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Java API documentation generated with DocFlex/Doclet 1.6.1 using JavadocPro template set.
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc, which is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com