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

Annotation Type EnableRedisHttpSession

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
 @Import(value=RedisHttpSessionConfiguration.class)
 @Configuration(proxyBeanMethods=false)
public @interface EnableRedisHttpSession

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

 @Configuration
 @EnableRedisHttpSession
 public class RedisHttpSessionConfig {

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

 }
 

More advanced configurations can extend RedisHttpSessionConfiguration instead.

Since:

1.0

See Also:

EnableSpringHttpSession

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	cleanupCron The cron expression for expired session cleanup job.
FlushMode	flushMode Flush mode for the Redis sessions.
int	maxInactiveIntervalInSeconds The session timeout in seconds.
RedisFlushMode	redisFlushMode Deprecated. since 2.2.0 in favor of flushMode()
java.lang.String	redisNamespace Defines a unique namespace for keys.
SaveMode	saveMode Save mode for the session.

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

@Deprecated
public abstract RedisFlushMode redisFlushMode

Deprecated. since 2.2.0 in favor of flushMode()

Flush mode for the Redis sessions. The default is ON_SAVE which only updates the backing Redis when SessionRepository.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

Since:

1.1

Default:

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

flushMode

public abstract FlushMode flushMode

Flush mode for the Redis sessions. The default is ON_SAVE which only updates the backing Redis when SessionRepository.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 FlushMode to use

Since:

2.2.0

Default:

org.springframework.session.FlushMode.ON_SAVE

cleanupCron

public abstract java.lang.String cleanupCron

The cron expression for expired session cleanup job. By default runs every minute.

Returns:

the session cleanup cron expression

Since:

2.0.0

Default:

"0 * * * * *"

saveMode

public abstract SaveMode saveMode

Save mode for the session. The default is SaveMode.ON_SET_ATTRIBUTE, which only saves changes made to session.

Returns:

the save mode

Since:

2.2.0

Default:

org.springframework.session.SaveMode.ON_SET_ATTRIBUTE