org.wizard4j.engine
Class SessionManager

java.lang.Object
  org.wizard4j.engine.SessionManager

Direct Known Subclasses:

FlowchartEngine, HtmlWrapper

public abstract class SessionManager
extends java.lang.Object

Abstract class that provides session management functionality to its subclasses. Sessions added by its subclasses will be removed after a period of inactivity.

Constructor Summary

SessionManager(int sessionTimeout)

Method Summary

void	cancel(java.lang.String sessionId) Allows to explicitly remove a managed session.
EGroupType	getDefaultGroupType()
ResultNode	getResult(java.lang.String sessionId) Cfr.
int	getSessionTimeout()
FlowchartResponse	index(java.lang.String sessionId, int index) Cfr.
boolean	isDefaultAllowMultipleRatesPerRun()
boolean	isDefaultAllowMultipleSavesPerRun()
boolean	isDefaultAutomaticSave()
boolean	isDefaultKeepStateInResponse()
boolean	isDefaultMaskCancelAction()
boolean	isDefaultMaskIndexAction()
boolean	isDefaultMaskNextAction()
boolean	isDefaultMaskPreviousAction()
boolean	isDefaultMaskRateAction()
boolean	isDefaultMaskSaveAction()
boolean	isDefaultMaskStartAction()
boolean	isDefaultMaskStateAction()
boolean	isDefaultResendResponseAtRequestError()
boolean	isDefaultResendResponseWithErrorAtParameterError()
FlowchartResponse	next(java.lang.String sessionId, FlowchartRequest request) Cfr.
FlowchartResponse	previous(java.lang.String sessionId) Cfr.
FlowchartResponse	rate(java.lang.String sessionId, int rating) Cfr.
FlowchartResponse	save(java.lang.String sessionId) Cfr.
void	setActionMask(java.lang.String sessionId, EUserAction action, boolean mask) Cfr.
void	setAllowMultipleRatesPerRun(java.lang.String sessionId, boolean allowMultipleRatesPerRun) Cfr.
void	setAllowMultipleSavesPerRun(java.lang.String sessionId, boolean allowMultipleSavesPerRun) Cfr.
void	setAutomaticSave(java.lang.String sessionId, boolean automaticSave) Cfr.
void	setDefaultAllowMultipleRatesPerRun(boolean defaultAllowMultipleRatesPerRun)
void	setDefaultAllowMultipleSavesPerRun(boolean defaultAllowMultipleSavesPerRun)
void	setDefaultAutomaticSave(boolean defaultAutomaticSave)
void	setDefaultGroupType(EGroupType defaultGroupType)
void	setDefaultKeepStateInResponse(boolean defaultKeepStateInResponse)
void	setDefaultMaskCancelAction(boolean defaultMaskCancelAction)
void	setDefaultMaskIndexAction(boolean defaultMaskIndexAction)
void	setDefaultMaskNextAction(boolean defaultMaskNextAction)
void	setDefaultMaskPreviousAction(boolean defaultMaskPreviousAction)
void	setDefaultMaskRateAction(boolean defaultMaskRateAction)
void	setDefaultMaskSaveAction(boolean defaultMaskSaveAction)
void	setDefaultMaskStartAction(boolean defaultMaskStartAction)
void	setDefaultMaskStateAction(boolean defaultMaskStateAction)
void	setDefaultResendResponseAtRequestError(boolean defaultResendResponseAtRequestError)
void	setDefaultResendResponseWithErrorAtParameterError(boolean defaultResendResponseWithErrorAtParameterError)
void	setFlowchartMonitor(java.lang.String sessionId, FlowchartMonitor flowchartMonitor) Cfr.
void	setGroupType(java.lang.String sessionId, EGroupType groupType) Cfr.
void	setResendResponseAtRequestError(java.lang.String sessionId, boolean resendResponseAtRequestError) Cfr.
void	setResendResponseWithErrorAtParameterError(java.lang.String sessionId, boolean resendResponseWithErrorAtParameterError) Cfr.
void	setStoreStateInResponse(java.lang.String sessionId, boolean storeStateInresponse) Cfr.
FlowchartResponse	start(java.lang.String sessionId) Cfr.
FlowchartResponse	state(java.lang.String sessionId, java.lang.String state) Cfr.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManager

public SessionManager(int sessionTimeout)

Parameters:

sessionTimeout -

Method Detail

cancel

public void cancel(java.lang.String sessionId)
            throws NonExistingSessionException

Allows to explicitly remove a managed session.

Parameters:

sessionId -

Throws:

NonExistingSessionException

start

public FlowchartResponse start(java.lang.String sessionId)
                        throws NonExistingSessionException,
                               UnexpectedRequestException

Cfr. FlowchartSession.start()

Parameters:

sessionId -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

next

public FlowchartResponse next(java.lang.String sessionId,
                              FlowchartRequest request)
                       throws NonExistingSessionException,
                              UnexpectedRequestException,
                              InvalidValueException

Cfr. FlowchartSession.next(FlowchartRequest)

Parameters:

sessionId -

request -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

InvalidValueException

previous

public FlowchartResponse previous(java.lang.String sessionId)
                           throws NonExistingSessionException,
                                  UnexpectedRequestException

Cfr. FlowchartSession.previous()

Parameters:

sessionId -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

index

public FlowchartResponse index(java.lang.String sessionId,
                               int index)
                        throws NonExistingSessionException,
                               UnexpectedRequestException

Cfr. FlowchartSession.index(int)

Parameters:

sessionId -

index -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

state

public FlowchartResponse state(java.lang.String sessionId,
                               java.lang.String state)
                        throws NonExistingSessionException,
                               UnexpectedRequestException

Cfr. FlowchartSession.state(String)

Parameters:

sessionId -

state -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

save

public FlowchartResponse save(java.lang.String sessionId)
                       throws NonExistingSessionException,
                              UnexpectedRequestException

Cfr. FlowchartSession.save()

Parameters:

sessionId -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

rate

public FlowchartResponse rate(java.lang.String sessionId,
                              int rating)
                       throws NonExistingSessionException,
                              UnexpectedRequestException

Cfr. FlowchartSession.rate(int)

Parameters:

sessionId -

rating -

Returns:

flowchartResponse

Throws:

NonExistingSessionException

UnexpectedRequestException

getSessionTimeout

public int getSessionTimeout()

Returns:

timeout in seconds after which an inactive session is removed

getDefaultGroupType

public EGroupType getDefaultGroupType()

Returns:

groupType

setDefaultGroupType

public void setDefaultGroupType(EGroupType defaultGroupType)

Parameters:

defaultGroupType -

isDefaultMaskStartAction

public boolean isDefaultMaskStartAction()

Returns:

true/false

setDefaultMaskStartAction

public void setDefaultMaskStartAction(boolean defaultMaskStartAction)

Parameters:

defaultMaskStartAction -

isDefaultMaskCancelAction

public boolean isDefaultMaskCancelAction()

Returns:

true/false

setDefaultMaskCancelAction

public void setDefaultMaskCancelAction(boolean defaultMaskCancelAction)

Parameters:

defaultMaskCancelAction -

isDefaultMaskNextAction

public boolean isDefaultMaskNextAction()

Returns:

true/false

setDefaultMaskNextAction

public void setDefaultMaskNextAction(boolean defaultMaskNextAction)

Parameters:

defaultMaskNextAction -

isDefaultMaskPreviousAction

public boolean isDefaultMaskPreviousAction()

Returns:

true/false

setDefaultMaskPreviousAction

public void setDefaultMaskPreviousAction(boolean defaultMaskPreviousAction)

Parameters:

defaultMaskPreviousAction -

isDefaultMaskIndexAction

public boolean isDefaultMaskIndexAction()

Returns:

true/false

setDefaultMaskIndexAction

public void setDefaultMaskIndexAction(boolean defaultMaskIndexAction)

Parameters:

defaultMaskIndexAction -

isDefaultMaskStateAction

public boolean isDefaultMaskStateAction()

Returns:

true/false

setDefaultMaskStateAction

public void setDefaultMaskStateAction(boolean defaultMaskStateAction)

Parameters:

defaultMaskStateAction -

isDefaultMaskSaveAction

public boolean isDefaultMaskSaveAction()

Returns:

true/false

setDefaultMaskSaveAction

public void setDefaultMaskSaveAction(boolean defaultMaskSaveAction)

Parameters:

defaultMaskSaveAction -

isDefaultMaskRateAction

public boolean isDefaultMaskRateAction()

Returns:

true/false

setDefaultMaskRateAction

public void setDefaultMaskRateAction(boolean defaultMaskRateAction)

Parameters:

defaultMaskRateAction -

isDefaultResendResponseAtRequestError

public boolean isDefaultResendResponseAtRequestError()

Returns:

true/false

setDefaultResendResponseAtRequestError

public void setDefaultResendResponseAtRequestError(boolean defaultResendResponseAtRequestError)

Parameters:

defaultResendResponseAtRequestError -

isDefaultResendResponseWithErrorAtParameterError

public boolean isDefaultResendResponseWithErrorAtParameterError()

Returns:

true/false

setDefaultResendResponseWithErrorAtParameterError

public void setDefaultResendResponseWithErrorAtParameterError(boolean defaultResendResponseWithErrorAtParameterError)

Parameters:

defaultResendResponseWithErrorAtParameterError -

isDefaultAllowMultipleSavesPerRun

public boolean isDefaultAllowMultipleSavesPerRun()

Returns:

true/false

setDefaultAllowMultipleSavesPerRun

public void setDefaultAllowMultipleSavesPerRun(boolean defaultAllowMultipleSavesPerRun)

Parameters:

defaultAllowMultipleSavesPerRun -

isDefaultAllowMultipleRatesPerRun

public boolean isDefaultAllowMultipleRatesPerRun()

Returns:

true/false

setDefaultAllowMultipleRatesPerRun

public void setDefaultAllowMultipleRatesPerRun(boolean defaultAllowMultipleRatesPerRun)

Parameters:

defaultAllowMultipleRatesPerRun -

isDefaultAutomaticSave

public boolean isDefaultAutomaticSave()

Returns:

true/false

setDefaultAutomaticSave

public void setDefaultAutomaticSave(boolean defaultAutomaticSave)

Parameters:

defaultAutomaticSave -

isDefaultKeepStateInResponse

public boolean isDefaultKeepStateInResponse()

Returns:

true/false

setDefaultKeepStateInResponse

public void setDefaultKeepStateInResponse(boolean defaultKeepStateInResponse)

Parameters:

defaultKeepStateInResponse -

setAllowMultipleRatesPerRun

public void setAllowMultipleRatesPerRun(java.lang.String sessionId,
                                        boolean allowMultipleRatesPerRun)
                                 throws NonExistingSessionException

Cfr. FlowchartSession.setAllowMultipleRatesPerRun(boolean)

Parameters:

sessionId -

allowMultipleRatesPerRun -

Throws:

NonExistingSessionException

setAllowMultipleSavesPerRun

public void setAllowMultipleSavesPerRun(java.lang.String sessionId,
                                        boolean allowMultipleSavesPerRun)
                                 throws NonExistingSessionException

Cfr. FlowchartSession.setAllowMultipleSavesPerRun(boolean)

Parameters:

sessionId -

allowMultipleSavesPerRun -

Throws:

NonExistingSessionException

setAutomaticSave

public void setAutomaticSave(java.lang.String sessionId,
                             boolean automaticSave)
                      throws NonExistingSessionException

Cfr. FlowchartSession.setAutomaticSave(boolean)

Parameters:

sessionId -

automaticSave -

Throws:

NonExistingSessionException

setStoreStateInResponse

public void setStoreStateInResponse(java.lang.String sessionId,
                                    boolean storeStateInresponse)
                             throws NonExistingSessionException

Cfr. FlowchartSession.setStoreStateInResponse(boolean)

Parameters:

sessionId -

storeStateInresponse -

Throws:

NonExistingSessionException

setFlowchartMonitor

public void setFlowchartMonitor(java.lang.String sessionId,
                                FlowchartMonitor flowchartMonitor)
                         throws NonExistingSessionException

Cfr. FlowchartSession.setFlowchartMonitor(FlowchartMonitor)

Parameters:

sessionId -

flowchartMonitor -

Throws:

NonExistingSessionException

setGroupType

public void setGroupType(java.lang.String sessionId,
                         EGroupType groupType)
                  throws NonExistingSessionException

Cfr. FlowchartSession.setGroupType(EGroupType)

Parameters:

sessionId -

groupType -

Throws:

NonExistingSessionException

setActionMask

public void setActionMask(java.lang.String sessionId,
                          EUserAction action,
                          boolean mask)
                   throws NonExistingSessionException

Cfr. FlowchartSession.setActionMask(EUserAction, boolean)

Parameters:

sessionId -

action -

mask -

Throws:

NonExistingSessionException

setResendResponseAtRequestError

public void setResendResponseAtRequestError(java.lang.String sessionId,
                                            boolean resendResponseAtRequestError)
                                     throws NonExistingSessionException

Cfr. FlowchartSession.setResendResponseAtRequestError(boolean)

Parameters:

sessionId -

resendResponseAtRequestError -

Throws:

NonExistingSessionException

setResendResponseWithErrorAtParameterError

public void setResendResponseWithErrorAtParameterError(java.lang.String sessionId,
                                                       boolean resendResponseWithErrorAtParameterError)
                                                throws NonExistingSessionException

Cfr. FlowchartSession.setResendResponseWithErrorAtParameterError(boolean)

Parameters:

sessionId -

resendResponseWithErrorAtParameterError -

Throws:

NonExistingSessionException

getResult

public ResultNode getResult(java.lang.String sessionId)
                     throws NonExistingSessionException

Cfr. FlowchartSession.getResult()

Parameters:

sessionId -

Returns:

result node tree

Throws:

NonExistingSessionException