org.springframework.session

Class MapReactorSessionRepository

java.lang.Object

org.springframework.session.MapReactorSessionRepository

All Implemented Interfaces:

ReactorSessionRepository<MapSession>

public class MapReactorSessionRepository
extends java.lang.Object
implements ReactorSessionRepository<MapSession>

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:

2.0

Constructor Summary

Constructors

Constructor and Description
MapReactorSessionRepository() Creates an instance backed by a ConcurrentHashMap.
MapReactorSessionRepository(java.lang.Iterable<Session> sessions) Creates a new instance backed by the provided Map.
MapReactorSessionRepository(java.util.Map<java.lang.String,Session> sessions) Creates a new instance backed by the provided Map.
MapReactorSessionRepository(Session... sessions) Creates a new instance backed by the provided Map.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<MapSession>	createSession() Creates a new Session that is capable of being persisted by this ReactorSessionRepository.
reactor.core.publisher.Mono<java.lang.Void>	delete(java.lang.String id) Deletes the Session with the given Session.getId() or does nothing if the Session is not found.
reactor.core.publisher.Mono<MapSession>	findById(java.lang.String id) Gets the Session by the Session.getId() or null if no Session is found.
reactor.core.publisher.Mono<java.lang.Void>	save(MapSession session) Ensures the Session created by ReactorSessionRepository.createSession() is saved.
void	setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval) If non-null, this value is used to override Session.setMaxInactiveInterval(Duration).

Methods inherited from class java.lang.Object

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

Constructor Detail

MapReactorSessionRepository

public MapReactorSessionRepository()

Creates an instance backed by a ConcurrentHashMap.

MapReactorSessionRepository

public MapReactorSessionRepository(java.util.Map<java.lang.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.

MapReactorSessionRepository

public MapReactorSessionRepository(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.

MapReactorSessionRepository

public MapReactorSessionRepository(java.lang.Iterable<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 Detail

setDefaultMaxInactiveInterval

public void setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval)

If non-null, this value is used to override Session.setMaxInactiveInterval(Duration).

Parameters:

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

save

public reactor.core.publisher.Mono<java.lang.Void> save(MapSession session)

Description copied from interface: ReactorSessionRepository

Ensures the Session created by ReactorSessionRepository.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 ReactorSessionRepository<MapSession>

Parameters:

session - the Session to save

Returns:

indicator of operation completion

findById

public reactor.core.publisher.Mono<MapSession> findById(java.lang.String id)

Description copied from interface: ReactorSessionRepository

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

Specified by:

findById in interface ReactorSessionRepository<MapSession>

Parameters:

id - the Session.getId() to lookup

Returns:

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

delete

public reactor.core.publisher.Mono<java.lang.Void> delete(java.lang.String id)

Description copied from interface: ReactorSessionRepository

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

Specified by:

delete in interface ReactorSessionRepository<MapSession>

Parameters:

id - the Session.getId() to delete

Returns:

indicator of operation completion

createSession

public reactor.core.publisher.Mono<MapSession> createSession()

Description copied from interface: ReactorSessionRepository

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

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

Returns:

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