Package com.aquima.web.sessionmanager

Class AquimaSessionsMap

java.lang.Object

com.aquima.web.sessionmanager.AquimaSessionsMap

All Implemented Interfaces:

com.blueriq.component.api.IAquimaSessionsMap, Serializable, org.springframework.beans.factory.DisposableBean

public class AquimaSessionsMap
extends Object
implements com.blueriq.component.api.IAquimaSessionsMap, Serializable, org.springframework.beans.factory.DisposableBean

This session manager implementation is a session scoped Spring bean.

Author:

Danny Roest, Jon van Leuven

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AquimaSessionsMap(long timeout, TimeUnit unit)	Creates a new instance without a work unit executor.
AquimaSessionsMap(com.blueriq.component.api.workunit.IWorkUnitExecutor executor, long timeout, TimeUnit unit)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addChildSession(String parentSessionId, com.blueriq.component.api.IAquimaSession childSession)
void	addSession(com.blueriq.component.api.IAquimaSession aquimaSession)	Adds the webPortalSession to the httpSession and creates a new unique id for this session.
void	cleanIdleSessions()
void	closeSession(String aquimaSessionId)
void	destroy()
void	flush()
List<String>	getAvailableSessionIds()
List<com.blueriq.component.api.IAquimaSession>	getChildSessions(String sessionId)
List<com.blueriq.component.api.IAquimaSession>	getChildSessions(String sessionId, String pageName)
List<String>	getMainSessionIds()
com.blueriq.component.api.IAquimaSession	getRootSession(String sessionId)
com.blueriq.component.api.IAquimaSession	getSession(String aquimaSessionId)	Returns the the webPortalSession belonging to the session id in the request.
com.blueriq.component.api.IAquimaSession	getSession(String aquimaSessionId, com.blueriq.component.api.FlushMode flushMode)
long	getSessionTimeoutMillis()
boolean	hasSession(String sessionId)
boolean	isSessionCircularDependent(String sessionId, String childSessionId, String pageName)	This method checks if a session contains itself through its children.
void	keepAlive(String aquimaSessionId)
void	updateSession(com.blueriq.component.api.IAquimaSession aquimaSession)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.blueriq.component.api.IAquimaSessionsMap

terminateSession

Constructor Details

AquimaSessionsMap

public AquimaSessionsMap(long timeout,
 TimeUnit unit)

Creates a new instance without a work unit executor.

Parameters:

timeout - the session timeout

unit - the units for the session timeout

AquimaSessionsMap

public AquimaSessionsMap(com.blueriq.component.api.workunit.IWorkUnitExecutor executor,
 long timeout,
 TimeUnit unit)

Creates a new instance. The optional executor will be used to close sessions within a transaction.

Parameters:

executor - the optional work unit executor, may be null

timeout - the session timeout

unit - the units for the session timeout

Method Details

getSessionTimeoutMillis

public long getSessionTimeoutMillis()

Specified by:

getSessionTimeoutMillis in interface com.blueriq.component.api.IAquimaSessionsMap

addSession

public void addSession(com.blueriq.component.api.IAquimaSession aquimaSession)
                throws com.blueriq.component.api.exception.DuplicateSessionException

Adds the webPortalSession to the httpSession and creates a new unique id for this session.

Specified by:

addSession in interface com.blueriq.component.api.IAquimaSessionsMap

Parameters:

aquimaSession - the webPortalSession to put on the http session

Throws:

com.blueriq.component.api.exception.DuplicateSessionException

addChildSession

public void addChildSession(String parentSessionId,
 com.blueriq.component.api.IAquimaSession childSession)

Specified by:

addChildSession in interface com.blueriq.component.api.IAquimaSessionsMap

hasSession

public boolean hasSession(String sessionId)

Specified by:

hasSession in interface com.blueriq.component.api.IAquimaSessionsMap

closeSession

public void closeSession(String aquimaSessionId)
                  throws com.blueriq.component.api.exception.UnknownSessionException

Specified by:

closeSession in interface com.blueriq.component.api.IAquimaSessionsMap

Throws:

com.blueriq.component.api.exception.UnknownSessionException

cleanIdleSessions

public void cleanIdleSessions()

Specified by:

cleanIdleSessions in interface com.blueriq.component.api.IAquimaSessionsMap

keepAlive

public void keepAlive(String aquimaSessionId)
               throws com.blueriq.component.api.exception.UnknownSessionException

Specified by:

keepAlive in interface com.blueriq.component.api.IAquimaSessionsMap

Throws:

com.blueriq.component.api.exception.UnknownSessionException

getSession

public com.blueriq.component.api.IAquimaSession getSession(String aquimaSessionId)
                                                    throws com.blueriq.component.api.exception.UnknownSessionException

Returns the the webPortalSession belonging to the session id in the request.

Throws an IllegalStateException when there is no web portal session found for the session id in the request

Specified by:

getSession in interface com.blueriq.component.api.IAquimaSessionsMap

Parameters:

aquimaSessionId - The requested aquima session id

Returns:

the webPortalSession belonging to the session id in the request.

Throws:

com.blueriq.component.api.exception.UnknownSessionException

getSession

public com.blueriq.component.api.IAquimaSession getSession(String aquimaSessionId,
 com.blueriq.component.api.FlushMode flushMode)
                                                    throws com.blueriq.component.api.exception.UnknownSessionException

Specified by:

getSession in interface com.blueriq.component.api.IAquimaSessionsMap

Throws:

com.blueriq.component.api.exception.UnknownSessionException

getAvailableSessionIds

public List<String> getAvailableSessionIds()

Specified by:

getAvailableSessionIds in interface com.blueriq.component.api.IAquimaSessionsMap

getMainSessionIds

public List<String> getMainSessionIds()

Specified by:

getMainSessionIds in interface com.blueriq.component.api.IAquimaSessionsMap

updateSession

public void updateSession(com.blueriq.component.api.IAquimaSession aquimaSession)

Specified by:

updateSession in interface com.blueriq.component.api.IAquimaSessionsMap

flush

public void flush()

Specified by:

flush in interface com.blueriq.component.api.IAquimaSessionsMap

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

getChildSessions

public List<com.blueriq.component.api.IAquimaSession> getChildSessions(String sessionId)

Specified by:

getChildSessions in interface com.blueriq.component.api.IAquimaSessionsMap

getChildSessions

public List<com.blueriq.component.api.IAquimaSession> getChildSessions(String sessionId,
 String pageName)

Specified by:

getChildSessions in interface com.blueriq.component.api.IAquimaSessionsMap

getRootSession

public com.blueriq.component.api.IAquimaSession getRootSession(String sessionId)

Specified by:

getRootSession in interface com.blueriq.component.api.IAquimaSessionsMap

isSessionCircularDependent

public boolean isSessionCircularDependent(String sessionId,
 String childSessionId,
 String pageName)

This method checks if a session contains itself through its children.

Parameters:

sessionId - The session Id for the current checked session

childSessionId - The session Id of a child session of the current checked session

Returns:

false, if session does not contain itself through its children. true, if session contains itself through its children.