org.tentackle.web.app

Class WebSessionKeyCache<T>

java.lang.Object

org.tentackle.web.app.WebSessionKeyCache<T>

Type Parameters:

T - the session key type

public class WebSessionKeyCache<T>
extends Object

A cache mapping user session infos to the web container's session keys.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
WebSessionKeyCache() Creates a session key cache.

Method Summary

Modifier and Type	Method and Description
void	addSession(T sessionKey, org.tentackle.session.SessionInfo sessionInfo) Adds a mapping between a session and a user info. This is usually done in the login controller.
org.tentackle.session.SessionInfo	getSession(T sessionKey) Gets the session.
Collection<T>	getSessionKeys(org.tentackle.session.SessionInfo sessionInfo) Gets the session keys for a user session info.
void	removeSession(T sessionKey) Removes a mapping between a session and a user info. This is usually done in the logout controller.
void	startup(long cleanupInterval) Starts the session key cache.
void	terminate() Terminates the session cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSessionKeyCache

public WebSessionKeyCache()

Creates a session key cache.

Method Detail

startup

public void startup(long cleanupInterval)
             throws org.tentackle.misc.ApplicationException

Starts the session key cache.

This will start a thread to cleanup crashed sessions.

Parameters:

cleanupInterval - interval in [ms] to run cleanup

Throws:

org.tentackle.misc.ApplicationException - if the cleanup thread is already running

terminate

public void terminate()
               throws org.tentackle.misc.ApplicationException

Terminates the session cache.

Throws:

org.tentackle.misc.ApplicationException - if the cleanup thread is not running at all

addSession

public void addSession(T sessionKey,
                       org.tentackle.session.SessionInfo sessionInfo)

Adds a mapping between a session and a user info.
This is usually done in the login controller. If a session with that key already exists, the user info will be replaced.

Parameters:

sessionKey - the (unique) session key

sessionInfo - the user's session info

removeSession

public void removeSession(T sessionKey)

Removes a mapping between a session and a user info.
This is usually done in the logout controller. If there is no such session, the method will do nothing.

Parameters:

sessionKey - the (unique) session key

getSession

public org.tentackle.session.SessionInfo getSession(T sessionKey)

Gets the session.

Parameters:

sessionKey - the session key

Returns:

the session, null if no such session

getSessionKeys

public Collection<T> getSessionKeys(org.tentackle.session.SessionInfo sessionInfo)

Gets the session keys for a user session info.

Parameters:

sessionInfo - the user info

Returns:

the session keys, never null