org.springframework.session.data.redis

Class ReactiveRedisSessionRepository

java.lang.Object

org.springframework.session.data.redis.ReactiveRedisSessionRepository

All Implemented Interfaces:

ReactiveSessionRepository<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>

Direct Known Subclasses:

ReactiveRedisOperationsSessionRepository

public class ReactiveRedisSessionRepository
extends java.lang.Object
implements ReactiveSessionRepository<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>

A ReactiveSessionRepository that is implemented using Spring Data's ReactiveRedisOperations.

Since:

2.2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAMESPACE The default namespace for each key and channel in Redis used by Spring Session.

Constructor Summary

Constructors

Constructor and Description
ReactiveRedisSessionRepository(org.springframework.data.redis.core.ReactiveRedisOperations<java.lang.String,java.lang.Object> sessionRedisOperations) Create a new ReactiveRedisSessionRepository instance.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>	createSession() Creates a new Session that is capable of being persisted by this ReactiveSessionRepository.
reactor.core.publisher.Mono<java.lang.Void>	deleteById(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<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>	findById(java.lang.String id) Gets the Session by the Session.getId() or null if no Session is found.
org.springframework.data.redis.core.ReactiveRedisOperations<java.lang.String,java.lang.Object>	getSessionRedisOperations() Returns the ReactiveRedisOperations used for sessions.
reactor.core.publisher.Mono<java.lang.Void>	save(org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession session) Ensures the Session created by ReactiveSessionRepository.createSession() is saved.
void	setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval) Sets the maximum inactive interval in seconds between requests before newly created sessions will be invalidated.
void	setRedisKeyNamespace(java.lang.String namespace)
void	setSaveMode(SaveMode saveMode) Set the save mode.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAMESPACE

public static final java.lang.String DEFAULT_NAMESPACE

The default namespace for each key and channel in Redis used by Spring Session.

See Also:

Constant Field Values

Constructor Detail

ReactiveRedisSessionRepository

public ReactiveRedisSessionRepository(org.springframework.data.redis.core.ReactiveRedisOperations<java.lang.String,java.lang.Object> sessionRedisOperations)

Create a new ReactiveRedisSessionRepository instance.

Parameters:

sessionRedisOperations - the ReactiveRedisOperations to use for managing sessions

Method Detail

setRedisKeyNamespace

public void setRedisKeyNamespace(java.lang.String namespace)

setDefaultMaxInactiveInterval

public void setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval)

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

Parameters:

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

setSaveMode

public void setSaveMode(SaveMode saveMode)

Set the save mode.

Parameters:

saveMode - the save mode

getSessionRedisOperations

public org.springframework.data.redis.core.ReactiveRedisOperations<java.lang.String,java.lang.Object> getSessionRedisOperations()

Returns the ReactiveRedisOperations used for sessions.

Returns:

the ReactiveRedisOperations used for sessions

createSession

public reactor.core.publisher.Mono<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession> 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<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>

Returns:

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

save

public reactor.core.publisher.Mono<java.lang.Void> save(org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession 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<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>

Parameters:

session - the Session to save

Returns:

indicator of operation completion

findById

public reactor.core.publisher.Mono<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession> findById(java.lang.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<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>

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<java.lang.Void> deleteById(java.lang.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<org.springframework.session.data.redis.ReactiveRedisSessionRepository.RedisSession>

Parameters:

id - the Session.getId() to delete

Returns:

indicator of operation completion