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

Annotation Interface EnableRedisIndexedHttpSession

@Retention(RUNTIME) @Target(TYPE) @Documented @Import(RedisIndexedHttpSessionConfiguration.class) public @interface EnableRedisIndexedHttpSession
Add this annotation to an @Configuration class to expose the SessionRepositoryFilter as a bean named springSessionRepositoryFilter and backed by RedisIndexedSessionRepository. In order to leverage the annotation, a single RedisConnectionFactory must be provided. For example: 
 @Configuration(proxyBeanMethods = false)
 @EnableRedisIndexedHttpSession
 public class RedisHttpSessionConfig {

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

 }
More advanced configurations can extend RedisIndexedHttpSessionConfiguration instead.
Since:
3.0.0
See Also:
  • EnableSpringHttpSession

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    cleanupCron
    The cron expression for expired session cleanup job.
    org.springframework.session.FlushMode
    flushMode
    Flush mode for the Redis sessions.
    int
    maxInactiveIntervalInSeconds
    The session timeout in seconds.
    String
    redisNamespace
    Defines a unique namespace for keys.
    org.springframework.session.SaveMode
    saveMode
    Save mode for the session.

  • Element Details

    • maxInactiveIntervalInSeconds

      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

      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"

    • flushMode

      org.springframework.session.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
      Default:
      ON_SAVE

    • saveMode

      org.springframework.session.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
      Default:
      ON_SET_ATTRIBUTE

    • cleanupCron

      String cleanupCron
      The cron expression for expired session cleanup job. By default runs every minute.
      Returns:
      the session cleanup cron expression
      Default:
      "0 * * * * *"