ibspan.tss.agents.sha.session
Class ActionDispatcherWithSessionTracking

java.lang.Object
  jade.core.behaviours.Behaviour
      jade.core.behaviours.CompositeBehaviour
          jade.core.behaviours.SerialBehaviour
              jade.core.behaviours.FSMBehaviour
                  jade.proto.states.HandlerSelector
                      ibspan.tss.messaging.SafeHandlerSelector
                          ibspan.tss.agents.sha.session.ActionDispatcherWithSessionTracking

All Implemented Interfaces:

Serializable

public class ActionDispatcherWithSessionTracking
extends SafeHandlerSelector

This class resolves the handler behaviour responsible for handling with incoming request and tracks the session with user. More precisely, it has the following multiply functionality:

• distincts between internal system request and user request (forwarded by ProxyAgent),
• for internal system request returns key in the same manner as ActionDispatcher does,
• for user request returns the key reflecting the name of action the user is wishing to be executed by the system; more precisely, it is the name of actionName parameter in incoming request. For example, the the following content of a requuest:

                (action (agent-identifier :name sha-1)
                  (SHA-process-user-request
                                  :actionName "find-restaurant"
                                  ....
                  )
                )
   

  results in returning the following key: find-restaurant which, of course, must be bounded with the Behaviour realizing the user request.
• checks, whether mapped Behaviour requires authorization from the user; if the user is not logged in, it is prompted with the login screen (more precisely the class returns the Behaviour realizing this prompting process; the developer is obligated to register all behaviours and points which require authorization;
• for future processing logs each user request (of logged-in user) into History model, using HistoryLogger;
• opens session for the user; the user is identified by her peerID parameters, which usually stands for IP of her computer; each session is represented by Session object, assiociated with Session.SessionData object, so multi-stepped scenarios could operate on data gathered during the session; map of sessions is provided for other behaviours by SessionHandlingAgent;

Author:

Maciej Gawinecki

See Also:

ActionDispatcher, Action, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jade.core.behaviours.Behaviour

Behaviour.RunnableChangedEvent

Field Summary

Fields inherited from class jade.proto.states.HandlerSelector

SELECTION_NOK, SELECTION_OK

Fields inherited from class jade.core.behaviours.FSMBehaviour

currentName, lastStates, previousName

Fields inherited from class jade.core.behaviours.CompositeBehaviour

currentExecuted

Fields inherited from class jade.core.behaviours.Behaviour

myEvent, NOTIFY_DOWN, NOTIFY_UP, parent, STATE_BLOCKED, STATE_READY, STATE_RUNNING

Constructor Summary

ActionDispatcherWithSessionTracking(Agent a, DataStore ds, HistoryLogger historyLogger, Object accessKey, Object actionNameKey, Object actKey)
Constructs action dispatcher.

Method Summary

protected Object	getSelectionKey_internal(Object o) Subclasses must provide a concrete implementation for this method.
void	registerHandler(boolean requiresAuthorization, Object key, Behaviour h) Register the bounding between an handler and a key.

Methods inherited from class ibspan.tss.messaging.SafeHandlerSelector

getSelectionKey, registerErrorHandler

Methods inherited from class jade.proto.states.HandlerSelector

registerHandler

Methods inherited from class jade.core.behaviours.FSMBehaviour

checkTermination, deregisterState, forceTransitionTo, getChildren, getCurrent, getLastExitValue, getName, getPrevious, getState, handleInconsistentFSM, handleStateEntered, onEnd, registerDefaultTransition, registerDefaultTransition, registerFirstState, registerLastState, registerState, registerTransition, registerTransition, reset, resetStates, scheduleFirst, scheduleNext

Methods inherited from class jade.core.behaviours.SerialBehaviour

handle

Methods inherited from class jade.core.behaviours.CompositeBehaviour

action, block, done, registerAsChild, resetChildren, restart, setAgent

Methods inherited from class jade.core.behaviours.Behaviour

actionWrapper, block, getBehaviourName, getDataStore, getExecutionState, getParent, isRunnable, onStart, root, setBehaviourName, setDataStore, setExecutionState

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionDispatcherWithSessionTracking

public ActionDispatcherWithSessionTracking(Agent a,
                                           DataStore ds,
                                           HistoryLogger historyLogger,
                                           Object accessKey,
                                           Object actionNameKey,
                                           Object actKey)

Constructs action dispatcher.

Parameters:

a - is a reference to the Agent object.

ds - is DataStore which will be used locally.

historyLogger - is logger which logs request of the user in a database

accessKey - is the key to get the proper object from the DataStore, this is the object that will be later passed as argument to the method getSelectionKey.

actionNameKey - is the key to get the name of action resolved by this action dispatcher.

actKey - is the key in the DataStore to access Action from current request, extracted by this action dispatcher.

See Also:

SafeHandlerSelector.getSelectionKey(Object)

Method Detail

getSelectionKey_internal

protected final Object getSelectionKey_internal(Object o)

Description copied from class: SafeHandlerSelector

Subclasses must provide a concrete implementation for this method. It must return the key to which the handler was bound.

Specified by:

getSelectionKey_internal in class SafeHandlerSelector

Returns:

the key to which the handler was bound

registerHandler

public void registerHandler(boolean requiresAuthorization,
                            Object key,
                            Behaviour h)

Register the bounding between an handler and a key.

Parameters:

requiresAuthorization - true if the passed Behaviour realizes user request, which requires authorization

key - this is the key that must be later returned by the method getSelectionKey when the passed Behaviour must be selected

h - the control handler for this key