org.springframework.session.data.redis.config.annotation.web.server

Annotation Type EnableRedisWebSession

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
 @Import(value=RedisWebSessionConfiguration.class)
 @Configuration
public @interface EnableRedisWebSession

Add this annotation to an @Configuration class to expose the WebSessionManager as a bean named webSessionManager and backed by Reactive Redis. In order to leverage the annotation, a single ReactiveRedisConnectionFactory must be provided. For example:

 @Configuration
 @EnableRedisWebSession
 public class RedisWebSessionConfig {

     @Bean
     public LettuceConnectionFactory redisConnectionFactory() {
         return new LettuceConnectionFactory();
     }

 }
 

More advanced configurations can extend RedisWebSessionConfiguration instead.

Since:

2.0.0

See Also:

EnableSpringWebSession

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	maxInactiveIntervalInSeconds The session timeout in seconds.
RedisFlushMode	redisFlushMode Flush mode for the Redis sessions.
java.lang.String	redisNamespace Defines a unique namespace for keys.

Element Detail

maxInactiveIntervalInSeconds

public abstract int maxInactiveIntervalInSeconds

The session timeout in seconds. By default, it is set to 1800 seconds (30 minutes). This should be a non-negative integer.

Returns:

the seconds a session can be inactive before expiring

Default:

1800

redisNamespace

public abstract java.lang.String redisNamespace

Defines a unique namespace for keys. The value is used to isolate sessions by changing the prefix from default spring:session: to <redisNamespace>:.

For example, if you had an application named "Application A" that needed to keep the sessions isolated from "Application B" you could set two different values for the applications and they could function within the same Redis instance.

Returns:

the unique namespace for keys

Default:

"spring:session"

redisFlushMode

public abstract RedisFlushMode redisFlushMode

Flush mode for the Redis sessions. The default is ON_SAVE which only updates the backing Redis when ReactiveSessionRepository.save(Session) is invoked. In a web environment this happens just before the HTTP response is committed.

Setting the value to IMMEDIATE will ensure that the any updates to the Session are immediately written to the Redis instance.

Returns:

the RedisFlushMode to use

Default:

org.springframework.session.data.redis.RedisFlushMode.ON_SAVE