ibspan.tss.agents.sha
Class SessionHandlingAgent

java.lang.Object
  jade.core.Agent
      ibspan.tss.agents.SystemAgent
          ibspan.tss.agents.sha.SessionHandlingAgent

All Implemented Interfaces:

TimerListener, Serializable, Runnable

public final class SessionHandlingAgent
extends SystemAgent

The centerpoint of the system mainly responsible for realizing user requests. It provides the following functionality:

• Plays role of controller in Model-View-Controller architecture: receives user requests from ProxyAgent, realize them itself (or delegates PersonalAgent to do it), requests ViewTransformingAgent for transforming results into browser-readable form and return the result to the ProxyAgent.
• Tracks session of interaction with the user: identify connection incoming from the same machines and authorizes user access to these features of the system, which need the user to be registrated and logged in.
• Logs requests of authorized user into History model and provides these data to ProfileManagingAgent for learning purposes.
• Realizes the following user scenarios: registration (and creating user account), logging in and logging out.

This functionality requires the following agents to be registrated in DirectoryFacilator before this agent starts working:

• ViewTransformingAgent -- for transforming prepared system responses,
• ProfileManagingAgent -- for initiliazing new user profile.

Additionally, when the user logs in, SessionHandlingAgent creates her representant in the system -- PersonalAgent, which will be responsible for realizing her requests until log out action.

Author:

Maciej Gawinecki

See Also:

ProfileManagingAgent, ViewTransformingAgent, ProxyAgent, PersonalAgent, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jade.core.Agent

Agent.Interrupted

Field Summary

static String	SERVICE_NAME
static String	SERVICE_OWNERSHIP
static String	SERVICE_TYPE

Fields inherited from class jade.core.Agent

AP_ACTIVE, AP_DELETED, AP_IDLE, AP_INITIATED, AP_MAX, AP_MIN, AP_SUSPENDED, AP_WAITING, D_ACTIVE, D_MAX, D_MIN, D_RETIRED, D_SUSPENDED, D_UNKNOWN

Constructor Summary

SessionHandlingAgent()
Constructs SessionHandlingAgent.

Method Summary

protected void	activateProperties(Properties conf) Activates configuration by processing given properties.
HistoryDAO	getHistoryDAO()
ServiceFinder	getPersonalService() Returns service finder gathering information about personal agents.
ServiceFinder	getProfilingService() Return service finder gathering information about profile managing services.
static ServiceDescription	getServiceDescription() Returns information about the service this agent provides.
SessionsMap	getSessions() Returns map of sessions this agent is engades with the user.
TemplatesRegister	getTemplates() Return register of templates, which behaviours uses to construct layout of screen returned to the user.
OntModel	getTemplatesDBModel()
OntModel	getUMModel()
UsersDAO	getUsersDBInterface()
ServiceFinder	getViewTransformers() Returns service finder gathering information about view transformers registered in DF.
protected void	setup() Loads configuration from properties file for this agent and passes it to SystemAgent.activateProperties(Properties).

Methods inherited from class jade.core.Agent

addBehaviour, afterClone, afterMove, beforeClone, beforeMove, blockingReceive, blockingReceive, blockingReceive, blockingReceive, changeStateTo, clean, doActivate, doClone, doDelete, doMove, doSuspend, doTimeOut, doWait, doWait, doWake, getAgentState, getAID, getAMS, getArguments, getContainerController, getContentManager, getCurQueueSize, getDefaultDF, getHap, getHelper, getLocalName, getName, getO2AObject, getProperty, getQueueSize, getState, here, notifyChangeBehaviourState, notifyRestarted, postMessage, putBack, putO2AObject, receive, receive, removeBehaviour, restartLater, restore, restoreBufferedState, run, send, setArguments, setEnabledO2ACommunication, setGenerateBehaviourEvents, setQueueSize, takeDown, waitUntilStarted, write

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_TYPE

public static final String SERVICE_TYPE

See Also:

Constant Field Values

SERVICE_OWNERSHIP

public static final String SERVICE_OWNERSHIP

See Also:

Constant Field Values

Constructor Detail

SessionHandlingAgent

public SessionHandlingAgent()

Constructs SessionHandlingAgent.

Method Detail

getHistoryDAO

public HistoryDAO getHistoryDAO()

Returns:

getTemplatesDBModel

public OntModel getTemplatesDBModel()

Returns:

getUMModel

public OntModel getUMModel()

Returns:

getViewTransformers

public ServiceFinder getViewTransformers()

Returns service finder gathering information about view transformers registered in DF.

Returns:

service finder for view transformers

getPersonalService

public ServiceFinder getPersonalService()

Returns service finder gathering information about personal agents. Particular agent is identified by userID of the user it represents and can be accessed by use of ServiceFinder.getOne(Object) method.

Returns:

service finder for personal agents

getProfilingService

public ServiceFinder getProfilingService()

Return service finder gathering information about profile managing services.

Returns:

service finder for profiling service

getUsersDBInterface

public UsersDAO getUsersDBInterface()

getTemplates

public TemplatesRegister getTemplates()

Return register of templates, which behaviours uses to construct layout of screen returned to the user.

Returns:

register of templates

getSessions

public SessionsMap getSessions()

Returns map of sessions this agent is engades with the user.

Returns:

sessions map

activateProperties

protected void activateProperties(Properties conf)

Description copied from class: SystemAgent

Activates configuration by processing given properties.

Specified by:

activateProperties in class SystemAgent

Parameters:

conf - are properties of the agent.

setup

protected void setup()

Description copied from class: SystemAgent

Loads configuration from properties file for this agent and passes it to SystemAgent.activateProperties(Properties). Property file is given as the first argument for the launched agent. The programmer is encouraged to call this method in her agent's setup() method.

Overrides:

setup in class SystemAgent

getServiceDescription

public static ServiceDescription getServiceDescription()

Returns information about the service this agent provides.

Returns:

service description