org.tentackle.app

Class SessionCache

java.lang.Object

org.tentackle.app.SessionCache

public class SessionCache
extends Object

A session cache for to map user infos to sessions.

Primarily used in web-applications where short-lived roundtrips must be associated to long-lived authenticated sessions.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
SessionCache() Creates a session cache.

Method Summary

Modifier and Type	Method and Description
void	addSession(Object sessionKey, SessionInfo userInfo) Adds a mapping between a session and a user info. This is usually done in the login controller.
SessionInfo	getSession(Object sessionKey) Gets the session.
void	removeSession(Object 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 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

SessionCache

public SessionCache()

Creates a session cache.

Method Detail

startup

public void startup(long cleanupInterval)
             throws ApplicationException

Starts the session cache.

This will start a thread to cleanup crashed sessions.

Parameters:

cleanupInterval - interval in [ms] to run cleanup

Throws:

ApplicationException - if the cleanup thread is already running

terminate

public void terminate()
               throws ApplicationException

Terminates the session cache.

Throws:

ApplicationException - if the cleanup thread is not running at all

addSession

public void addSession(Object sessionKey,
                       SessionInfo userInfo)

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

userInfo - the user info

removeSession

public void removeSession(Object 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 SessionInfo getSession(Object sessionKey)

Gets the session.

Parameters:

sessionKey - the session key

Returns:

the session, null if no such session