org.springframework.session.data.redis

Class RedisSessionRepository

java.lang.Object

org.springframework.session.data.redis.RedisSessionRepository

All Implemented Interfaces:

SessionRepository<org.springframework.session.data.redis.RedisSessionRepository.RedisSession>

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

A SessionRepository implementation that uses Spring Data's RedisOperations to store sessions is Redis.

This implementation does not support publishing of session events.

Since:

2.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.springframework.session.data.redis.RedisSessionRepository.RedisSession	createSession() Creates a new Session that is capable of being persisted by this SessionRepository.
void	deleteById(java.lang.String sessionId) Deletes the Session with the given Session.getId() or does nothing if the Session is not found.
org.springframework.session.data.redis.RedisSessionRepository.RedisSession	findById(java.lang.String sessionId) Gets the Session by the Session.getId() or null if no Session is found.
org.springframework.data.redis.core.RedisOperations<java.lang.String,java.lang.Object>	getSessionRedisOperations() Returns the RedisOperations used for sessions.
void	save(org.springframework.session.data.redis.RedisSessionRepository.RedisSession session) Ensures the Session created by SessionRepository.createSession() is saved.
void	setDefaultMaxInactiveInterval(java.time.Duration defaultMaxInactiveInterval) Set the default maxInactiveInterval.
void	setFlushMode(FlushMode flushMode) Set the flush mode.
void	setKeyNamespace(java.lang.String keyNamespace) Deprecated. since 2.4.0 in favor of setRedisKeyNamespace(String)
void	setRedisKeyNamespace(java.lang.String namespace) Set the Redis key 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

Constructor Detail

RedisSessionRepository

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

Create a new RedisSessionRepository instance.

Parameters:

sessionRedisOperations - the RedisOperations to use for managing sessions

Method Detail

setDefaultMaxInactiveInterval

public void setDefaultMaxInactiveInterval(java.time.Duration defaultMaxInactiveInterval)

Set the default maxInactiveInterval.

Parameters:

defaultMaxInactiveInterval - the default maxInactiveInterval

setKeyNamespace

@Deprecated
public void setKeyNamespace(java.lang.String keyNamespace)

Deprecated. since 2.4.0 in favor of setRedisKeyNamespace(String)

Set the key namespace.

Parameters:

keyNamespace - the key namespace

setRedisKeyNamespace

public void setRedisKeyNamespace(java.lang.String namespace)

Set the Redis key namespace.

Parameters:

namespace - the Redis key namespace

setFlushMode

public void setFlushMode(FlushMode flushMode)

Set the flush mode.

Parameters:

flushMode - the flush mode

setSaveMode

public void setSaveMode(SaveMode saveMode)

Set the save mode.

Parameters:

saveMode - the save mode

createSession

public org.springframework.session.data.redis.RedisSessionRepository.RedisSession 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<org.springframework.session.data.redis.RedisSessionRepository.RedisSession>

Returns:

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

save

public void save(org.springframework.session.data.redis.RedisSessionRepository.RedisSession 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<org.springframework.session.data.redis.RedisSessionRepository.RedisSession>

Parameters:

session - the Session to save

findById

public org.springframework.session.data.redis.RedisSessionRepository.RedisSession findById(java.lang.String sessionId)

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<org.springframework.session.data.redis.RedisSessionRepository.RedisSession>

Parameters:

sessionId - the Session.getId() to lookup

Returns:

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

deleteById

public void deleteById(java.lang.String sessionId)

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<org.springframework.session.data.redis.RedisSessionRepository.RedisSession>

Parameters:

sessionId - the Session.getId() to delete

getSessionRedisOperations

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

Returns the RedisOperations used for sessions.

Returns:

the RedisOperations used for sessions