Package org.springframework.session

Class ReactiveMapSessionRepository

java.lang.Object

org.springframework.session.ReactiveMapSessionRepository

All Implemented Interfaces:

ReactiveSessionRepository<MapSession>

public class ReactiveMapSessionRepository
extends Object
implements ReactiveSessionRepository<MapSession>

A ReactiveSessionRepository 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 must be a non-blocking map, and is itself responsible for purging the expired sessions.

The implementation does NOT support firing SessionDeletedEvent or SessionExpiredEvent.

Since:

2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<MapSession>	createSession()	Creates a new Session that is capable of being persisted by this ReactiveSessionRepository.
reactor.core.publisher.Mono<Void>	deleteById(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(String id)	Gets the Session by the Session.getId() or null if no Session is found.
reactor.core.publisher.Mono<Void>	save(MapSession session)	Ensures the Session created by ReactiveSessionRepository.createSession() is saved.
void	setDefaultMaxInactiveInterval(Duration defaultMaxInactiveInterval)	Set the maximum inactive interval in seconds between requests before newly created sessions will be invalidated.
void	setSessionIdGenerator(SessionIdGenerator sessionIdGenerator)	Sets the SessionIdGenerator to use.

Methods inherited from class java.lang.Object

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

Constructor Details

ReactiveMapSessionRepository

public ReactiveMapSessionRepository(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 reactor.core.publisher.Mono<Void> save(MapSession session)

Description copied from interface: ReactiveSessionRepository

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

Parameters:

session - the Session to save

Returns:

indicator of operation completion

findById

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

Description copied from interface: ReactiveSessionRepository

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

Specified by:

findById in interface ReactiveSessionRepository<MapSession>

Parameters:

id - the Session.getId() to lookup

Returns:

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

deleteById

public reactor.core.publisher.Mono<Void> deleteById(String id)

Description copied from interface: ReactiveSessionRepository

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

Specified by:

deleteById in interface ReactiveSessionRepository<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: ReactiveSessionRepository

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

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

Returns:

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

setSessionIdGenerator

public void setSessionIdGenerator(SessionIdGenerator sessionIdGenerator)

Sets the SessionIdGenerator to use.

Parameters:

sessionIdGenerator - the non-null SessionIdGenerator to use

Since:

3.2