com.bankframe.fe.statemachine.ext.sessionmanagers.servlet
Class UserSession

java.lang.Object
  com.bankframe.fe.statemachine.base.sessionmanagers.UserSession
      com.bankframe.fe.statemachine.ext.sessionmanagers.UserSession
          com.bankframe.fe.statemachine.ext.sessionmanagers.servlet.UserSession

All Implemented Interfaces:

IUserSession, IUserSession, java.io.Serializable

public class UserSession

extends UserSession

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.bankframe.fe.statemachine.base.sessionmanagers.IUserSession

STATE_ID_SOURCE_REQUEST, STATE_ID_SOURCE_REQUEST_THEN_SESSION, STATE_ID_SOURCE_SESSION, STATE_ID_SOURCE_SESSION_THEN_REQUEST, STATE_ID_SOURCE_UNDEFINED

Constructor Summary

UserSession(javax.servlet.http.HttpSession httpSession)
Creates new UserSession.

Method Summary

void	addStateVisit(IState state, IResponseData responseData) Records a new state visit, adding it to the history of this session.
IStateVisit	getHistory(IState state) Returns the most recent state visit which contains an immediate child of the given state.
IStateVisit	getHistoryStar(IState state) Returns the most recent state visit which contains a child of the given state.
javax.servlet.http.HttpSession	getHttpSession() This method returns the HttpSession given in the constructor.
java.lang.String	getId() The sessionId for this session.
void	invalidate() This method nullifies the references between this and all other objects, allowing this to be unloaded.

Methods inherited from class com.bankframe.fe.statemachine.ext.sessionmanagers.UserSession

clearAll, clearAllHistory, clearKeys, getAttribute, getAttributeNames, setAttribute

Methods inherited from class com.bankframe.fe.statemachine.base.sessionmanagers.UserSession

addAuthToken, getLocale, getMostRecentVisit, getSessionData, getStateIdSource, hasAllAuthTokens, hasAuthToken, removeAllAuthTokens, removeAuthToken, setLocale, setStateIdSource, wasStateVisited

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bankframe.fe.statemachine.base.sessionmanagers.IUserSession

addAuthToken, getLocale, getMostRecentVisit, getSessionData, getStateIdSource, hasAllAuthTokens, hasAuthToken, removeAllAuthTokens, removeAuthToken, setLocale, setStateIdSource, wasStateVisited

Constructor Detail

UserSession

public UserSession(javax.servlet.http.HttpSession httpSession)

Creates new UserSession.

Method Detail

getId

public java.lang.String getId()

The sessionId for this session.

Returns:

the sessionId for this session.

invalidate

public void invalidate()

This method nullifies the references between this and all other objects, allowing this to be unloaded.

Overrides:

invalidate in class UserSession

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

This method returns the HttpSession given in the constructor. It is used by the UserSessionManager to ensure the HttpSession is properly invalidated when the session is complete.

Returns:

HttpSession.

getHistoryStar

public IStateVisit getHistoryStar(IState state)

Returns the most recent state visit which contains a child of the given state.

If no such state visit exists, this method returns an IStateVisit that contains the given state and an empty IResponseData.

This is a synchronized wrapper about the superclass method.

Specified by:

getHistoryStar in interface IUserSession

Overrides:

getHistoryStar in class UserSession

Parameters:

state - the state being visited

Returns:

the appropriate state visit, or an IStateVisit containing the given IState and an empty IResponseData.

addStateVisit

public void addStateVisit(IState state,
                          IResponseData responseData)

Records a new state visit, adding it to the history of this session.

This is a synchronized wrapper about the superclass method.

Specified by:

addStateVisit in interface IUserSession

Overrides:

addStateVisit in class UserSession

Parameters:

state - the state being visited

responseData - the response data being given to the view

getHistory

public IStateVisit getHistory(IState state)

Returns the most recent state visit which contains an immediate child of the given state.

If no such state visit exists, this method returns an IStateVisit that contains the given state and an empty IResponseData.

This is a synchronized wrapper about the superclass method.

Specified by:

getHistory in interface IUserSession

Overrides:

getHistory in class UserSession

Parameters:

state - the state being visited

Returns:

the appropriate state visit, or an IStateVisit containing the given IState and an empty IResponseData.