com.amadeus.session.repository.inmemory

Class InMemoryRepository

java.lang.Object

com.amadeus.session.repository.inmemory.InMemoryRepository

All Implemented Interfaces:

SessionRepository, Closeable, AutoCloseable

public class InMemoryRepository
extends Object
implements SessionRepository

Session Repository implementation that stores session in memory. This class can be used for testing and development purposes. This repository will also be used for the web apps marked as non-distributable when distribution of sessions is not enforced.

We are storing session in memory in ConcurrentHashMap. For each session we store SessionData and session attributes. Multiple threads can access both separate session and same session id, and while repository is thread safe, functional concurrency when using same session id from different threads must be assured in application code (as is general case for HttpSession.

Sessions are cleaned-up by a special task running in separate thread every 60 seconds. Only one task is running at the given time and this is assured by SessionManager.schedule(String, Runnable, long) method.

Nested Class Summary

Nested classes/interfaces inherited from interface com.amadeus.session.SessionRepository

SessionRepository.CommitTransaction

Constructor Summary

Constructors

Constructor and Description
InMemoryRepository(String namespace) Constructor for in-memory repository.

Method Summary

Modifier and Type	Method and Description
boolean	cleanSessionsOnShutdown() If repository supports cleaning of sessions on application shutdown, it should return true from this method.
void	close() Called to shutdown the repository and release resources.
Set<String>	getAllKeys(SessionData session) Get all attribute keys stored in the session.
Collection<String>	getOwnedSessionIds() Returns session ids stored in repository and owned by current application node.
Object	getSessionAttribute(SessionData session, String attribute) Returns value of the attribute or null if attribute or session have not been found
SessionData	getSessionData(String id) Retrieves global session data from repository.
boolean	prepareRemove(SessionData session) Prepares session repository for removal of session.
void	remove(SessionData session) Removes session from the repository.
void	removeSessionAttribute(SessionData session, String name) The attribute for the session will be removed from the repository.
void	requestFinished() Called to clean up resources after the request has been completed and the session will no longer be used in the current thread.
void	sessionIdChange(SessionData sessionData) Called by session manager to notify repository that session id has changed.
void	setSessionAttribute(SessionData session, String name, Object value) Sets the value of the attribute for the session in the repository.
void	setSessionManager(SessionManager sessionManager) Links repository with the session management.
SessionRepository.CommitTransaction	startCommit(SessionData session) Starts transaction on remote session.
void	storeSessionData(SessionData sessionData) Stores global session data into repository

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryRepository

public InMemoryRepository(String namespace)

Constructor for in-memory repository.

Parameters:

namespace - the namespace of sessions stored in this repository

Method Detail

getSessionData

public SessionData getSessionData(String id)

Description copied from interface: SessionRepository

Retrieves global session data from repository.

Specified by:

getSessionData in interface SessionRepository

Parameters:

id - the session id

Returns:

retrieves global session data from repository or null if data wasn't found in repository.

storeSessionData

public void storeSessionData(SessionData sessionData)

Description copied from interface: SessionRepository

Stores global session data into repository

Specified by:

storeSessionData in interface SessionRepository

Parameters:

sessionData - the session information

getAllKeys

public Set<String> getAllKeys(SessionData session)

Description copied from interface: SessionRepository

Get all attribute keys stored in the session.

Specified by:

getAllKeys in interface SessionRepository

Parameters:

session - the session information

Returns:

all attribute keys stored in the session

getSessionAttribute

public Object getSessionAttribute(SessionData session,
                                  String attribute)

Description copied from interface: SessionRepository

Returns value of the attribute or null if attribute or session have not been found

Specified by:

getSessionAttribute in interface SessionRepository

Parameters:

session - the session information

attribute - the key of the attribute to retrieve

Returns:

value of the attribute or null if attribute or session have not been found

remove

public void remove(SessionData session)

Description copied from interface: SessionRepository

Removes session from the repository.

Specified by:

remove in interface SessionRepository

Parameters:

session - the session information

prepareRemove

public boolean prepareRemove(SessionData session)

Description copied from interface: SessionRepository

Prepares session repository for removal of session. May perform lock on the session. Returns true if caller can proceed with session removal.

Specified by:

prepareRemove in interface SessionRepository

Parameters:

session - the session information

Returns:

true if caller can proceed with session removal

startCommit

public SessionRepository.CommitTransaction startCommit(SessionData session)

Description copied from interface: SessionRepository

Starts transaction on remote session. Transactions are used during session commit. This mechanism allows execution of all operations related to commit in atomic manner, if such mechanism exists in underlying repository. See SessionRepository.CommitTransaction for more information.

Specified by:

startCommit in interface SessionRepository

Parameters:

session - the session information

Returns:

transaction linked to session.

setSessionManager

public void setSessionManager(SessionManager sessionManager)

Description copied from interface: SessionRepository

Links repository with the session management. The method is used to allow callback from repository to SessionManager.

Specified by:

setSessionManager in interface SessionRepository

Parameters:

sessionManager - the session manager to associate

requestFinished

public void requestFinished()

Description copied from interface: SessionRepository

Called to clean up resources after the request has been completed and the session will no longer be used in the current thread. Can be used to clean-up thread local store information, close connections etc.

Specified by:

requestFinished in interface SessionRepository

setSessionAttribute

public void setSessionAttribute(SessionData session,
                                String name,
                                Object value)

Description copied from interface: SessionRepository

Sets the value of the attribute for the session in the repository.

Specified by:

setSessionAttribute in interface SessionRepository

Parameters:

session - the session information

name - attribute name

value - attribute value. If session is stored remotely, attribute should be Serializable.

removeSessionAttribute

public void removeSessionAttribute(SessionData session,
                                   String name)

Description copied from interface: SessionRepository

The attribute for the session will be removed from the repository.

Specified by:

removeSessionAttribute in interface SessionRepository

Parameters:

session - the session information

name - attribute name

cleanSessionsOnShutdown

public boolean cleanSessionsOnShutdown()

Description copied from interface: SessionRepository

If repository supports cleaning of sessions on application shutdown, it should return true from this method.

Specified by:

cleanSessionsOnShutdown in interface SessionRepository

Returns:

true if repository supports cleaning of sessions on application shutdown

getOwnedSessionIds

public Collection<String> getOwnedSessionIds()

Description copied from interface: SessionRepository

Returns session ids stored in repository and owned by current application node. May throw UnsupportedOperationException if repository doesn't offer this functionality.

Specified by:

getOwnedSessionIds in interface SessionRepository

Returns:

a collection of session ids

close

public void close()

Description copied from interface: SessionRepository

Called to shutdown the repository and release resources.

Specified by:

close in interface SessionRepository

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

sessionIdChange

public void sessionIdChange(SessionData sessionData)

Description copied from interface: SessionRepository

Called by session manager to notify repository that session id has changed. It is up to repository to implement needed logic. It can rename keys immediately, or it can have some other strategy.

Specified by:

sessionIdChange in interface SessionRepository

Parameters:

sessionData - the session information