org.springframework.session

Class MapSessionRepository

java.lang.Object

org.springframework.session.MapSessionRepository

All Implemented Interfaces:

SessionRepository<ExpiringSession>

public class MapSessionRepository
extends Object
implements SessionRepository<ExpiringSession>

A SessionRepository backed by a Map and that uses a MapSession. By default a ConcurrentHashMap is used, but a custom Map can be injected to use distributed maps provided by NoSQL stores like Redis and Hazelcast.

The implementation does NOT support firing SessionDeletedEvent or SessionExpiredEvent.

Since:

1.0

Author:

Rob Winch

Constructor Summary

Constructors

Constructor and Description
MapSessionRepository() Creates an instance backed by a ConcurrentHashMap.
MapSessionRepository(Map<String,ExpiringSession> sessions) Creates a new instance backed by the provided Map.

Method Summary

Modifier and Type	Method and Description
ExpiringSession	createSession() Creates a new Session that is capable of being persisted by this SessionRepository.
void	delete(String id) Deletes the Session with the given Session.getId() or does nothing if the Session is not found.
ExpiringSession	getSession(String id) Gets the Session by the Session.getId() or null if no Session is found.
void	save(ExpiringSession session) Ensures the Session created by SessionRepository.createSession() is saved.
void	setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval) If non-null, this value is used to override ExpiringSession.setMaxInactiveIntervalInSeconds(int).

Methods inherited from class java.lang.Object

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

Constructor Detail

MapSessionRepository

public MapSessionRepository()

Creates an instance backed by a ConcurrentHashMap.

MapSessionRepository

public MapSessionRepository(Map<String,ExpiringSession> sessions)

Creates a new instance backed by the provided Map. This allows injecting a distributed Map.

Parameters:

sessions - the Map to use. Cannot be null.

Method Detail

setDefaultMaxInactiveInterval

public void setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval)

If non-null, this value is used to override ExpiringSession.setMaxInactiveIntervalInSeconds(int).

Parameters:

defaultMaxInactiveInterval - the number of seconds that the Session should be kept alive between client requests.

save

public void save(ExpiringSession session)

Description copied from interface: SessionRepository

Ensures the Session created by SessionRepository.createSession() is saved.

Some implementations may choose to save as the Session is updated by returning a Session that immediately persists any changes. In this case, this method may not actually do anything.

Specified by:

save in interface SessionRepository<ExpiringSession>

Parameters:

session - the Session to save

getSession

public ExpiringSession getSession(String id)

Description copied from interface: SessionRepository

Gets the Session by the Session.getId() or null if no Session is found.

Specified by:

getSession in interface SessionRepository<ExpiringSession>

Parameters:

id - the Session.getId() to lookup

Returns:

the Session by the Session.getId() or null if no Session is found.

delete

public void delete(String id)

Description copied from interface: SessionRepository

Deletes the Session with the given Session.getId() or does nothing if the Session is not found.

Specified by:

delete in interface SessionRepository<ExpiringSession>

Parameters:

id - the Session.getId() to delete

createSession

public ExpiringSession createSession()

Description copied from interface: SessionRepository

Creates a new Session that is capable of being persisted by this SessionRepository.

This allows optimizations and customizations in how the Session is persisted. For example, the implementation returned might keep track of the changes ensuring that only the delta needs to be persisted on a save.

Specified by:

createSession in interface SessionRepository<ExpiringSession>

Returns:

a new Session that is capable of being persisted by this SessionRepository