com.amadeus.session.repository.redis

Class RedisSessionRepository

java.lang.Object

com.amadeus.session.repository.redis.RedisSessionRepository

All Implemented Interfaces:

SessionRepository, Closeable, AutoCloseable

public class RedisSessionRepository
extends Object
implements SessionRepository

Main class for implementing Redis repository logic.

Nested Class Summary

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

SessionRepository.CommitTransaction

Constructor Summary

Constructors

Constructor and Description
RedisSessionRepository(RedisFacade redis, String namespace, String owner, ExpirationStrategy strategy, boolean sticky)

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) Retrieves all attribute keys associated with 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) This method retrieves 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) Changes session id.
byte[]	sessionKey(String sessionId) Returns session key used to index session in redis.
void	setSessionAttribute(SessionData session, String name, Object value) Sets the value of the attribute for the session in the repository.
void	setSessionManager(SessionManager sessionManager) This method starts a separate thread that listens to key expirations events.
SessionRepository.CommitTransaction	startCommit(SessionData session) Starts transaction on remote session.
void	storeSessionData(SessionData sessionData) The method stores session metadata in redis and marks session as accessed (resets session expire instant).

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisSessionRepository

public RedisSessionRepository(RedisFacade redis,
                              String namespace,
                              String owner,
                              ExpirationStrategy strategy,
                              boolean sticky)

Method Detail

setSessionManager

public void setSessionManager(SessionManager sessionManager)

This method starts a separate thread that listens to key expirations events.

Specified by:

setSessionManager in interface SessionRepository

Parameters:

sessionManager -

getSessionData

public SessionData getSessionData(String id)

This method retrieves session data from repository. The data retrieved from repository contains meta attributes such as: last accessed time, creation time, maximum inactive interval, flag if session is invalid (session becomes invalid when it is deleted or marked invalid), and if session stickiness is active, previous owner node id. All meta attributes start with following characters #:

Specified by:

getSessionData in interface SessionRepository

Parameters:

id - session id

Returns:

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

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.

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

sessionKey

public byte[] sessionKey(String sessionId)

Returns session key used to index session in redis.

Parameters:

sessionId -

Returns:

key as byte array

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

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

getAllKeys

public Set<String> getAllKeys(SessionData session)

Retrieves all attribute keys associated with session. No

Specified by:

getAllKeys in interface SessionRepository

Parameters:

session -

Returns:

all attribute keys stored in the session

storeSessionData

public void storeSessionData(SessionData sessionData)

The method stores session metadata in redis and marks session as accessed (resets session expire instant).

Specified by:

storeSessionData in interface SessionRepository

Parameters:

sessionData - the session information

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)

Changes session id. This renames key in redis and publishes the redis event if other nodes need to be notified.

Specified by:

sessionIdChange in interface SessionRepository

Parameters:

sessionData -