Package org.springframework.session

Class MapSessionRepository

java.lang.Object

org.springframework.session.MapSessionRepository

All Implemented Interfaces:

SessionRepository<MapSession>

public class MapSessionRepository
extends Object
implements SessionRepository<MapSession>

A SessionRepository backed by a Map and that uses a MapSession. The injected Map can be backed by a distributed NoSQL store like Hazelcast, for instance. Note that the supplied map itself is responsible for purging the expired sessions.

The implementation does NOT support firing SessionDeletedEvent or SessionExpiredEvent.

Since:

1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MapSession	createSession()	Creates a new Session that is capable of being persisted by this SessionRepository.
void	deleteById(String id)	Deletes the Session with the given Session.getId() or does nothing if the Session is not found.
MapSession	findById(String id)	Gets the Session by the Session.getId() or null if no Session is found.
void	save(MapSession session)	Ensures the Session created by SessionRepository.createSession() is saved.
void	setDefaultMaxInactiveInterval(Duration defaultMaxInactiveInterval)	Set the maximum inactive interval in seconds between requests before newly created sessions will be invalidated.

Methods inherited from class java.lang.Object

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

Constructor Details

MapSessionRepository

public MapSessionRepository(Map<String,Session> 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 Details

setDefaultMaxInactiveInterval

public void setDefaultMaxInactiveInterval(Duration defaultMaxInactiveInterval)

Set the maximum inactive interval in seconds between requests before newly created sessions will be invalidated. A negative time indicates that the session will never time out. The default is 30 minutes.

Parameters:

defaultMaxInactiveInterval - the default maxInactiveInterval

save

public void save(MapSession 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<MapSession>

Parameters:

session - the Session to save

findById

public MapSession findById(String id)

Description copied from interface: SessionRepository

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

Specified by:

findById in interface SessionRepository<MapSession>

Parameters:

id - the Session.getId() to lookup

Returns:

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

deleteById

public void deleteById(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:

deleteById in interface SessionRepository<MapSession>

Parameters:

id - the Session.getId() to delete

createSession

public MapSession 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<MapSession>

Returns:

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