com.amadeus.session

Interface SessionRepository

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

InMemoryRepository, RedisSessionRepository

public interface SessionRepository
extends Closeable

Implementation of session storage. If repository stores session remotely, the values stored in session should be Serializable or convertible into binary representation using a SerializerDeserializer implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SessionRepository.CommitTransaction The commit transaction on the session.

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 sessionData) 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 sessionData, 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 sessionData) Removes session from the repository.
void	removeSessionAttribute(SessionData sessionData, 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 sessionData, 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 sessionData) Starts transaction on remote session.
void	storeSessionData(SessionData sessionData) Stores global session data into repository

Method Detail

getSessionData

SessionData getSessionData(String id)

Retrieves global session data from repository.

Parameters:

id - the session id

Returns:

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

storeSessionData

void storeSessionData(SessionData sessionData)

Stores global session data into repository

Parameters:

sessionData - the session information

getAllKeys

Set<String> getAllKeys(SessionData sessionData)

Get all attribute keys stored in the session.

Parameters:

sessionData - the session information

Returns:

all attribute keys stored in the session

getSessionAttribute

Object getSessionAttribute(SessionData sessionData,
                           String attribute)

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

Parameters:

sessionData - 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

void remove(SessionData sessionData)

Removes session from the repository.

Parameters:

sessionData - the session information

prepareRemove

boolean prepareRemove(SessionData session)

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

Parameters:

session - the session information

Returns:

true if caller can proceed with session removal

setSessionManager

void setSessionManager(SessionManager sessionManager)

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

Parameters:

sessionManager - the session manager to associate

requestFinished

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. Can be used to clean-up thread local store information, close connections etc.

setSessionAttribute

void setSessionAttribute(SessionData sessionData,
                         String name,
                         Object value)

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

Parameters:

sessionData - the session information

name - attribute name

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

removeSessionAttribute

void removeSessionAttribute(SessionData sessionData,
                            String name)

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

Parameters:

sessionData - the session information

name - attribute name

startCommit

SessionRepository.CommitTransaction startCommit(SessionData sessionData)

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.

Parameters:

sessionData - the session information

Returns:

transaction linked to session.

cleanSessionsOnShutdown

boolean cleanSessionsOnShutdown()

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

Returns:

true if repository supports cleaning of sessions on application shutdown

getOwnedSessionIds

Collection<String> getOwnedSessionIds()

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

Returns:

a collection of session ids

close

void close()

Called to shutdown the repository and release resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

sessionIdChange

void sessionIdChange(SessionData sessionData)

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.

Parameters:

sessionData - the session information