Add EnableRedisHttpSession

Fixes gh-42

README.adoc

@@ -164,31 +164,13 @@ Add the following Spring Configuration:
 [source,java]
 ----
 @Configuration
+@EnableRedisHttpSession
 public class Config {
 
     @Bean
     public JedisConnectionFactory connectionFactory() throws Exception {
         return new JedisConnectionFactory();
     }
-
-    @Bean
-    public RedisTemplate<String,ExpiringSession> redisTemplate(RedisConnectionFactory connectionFactory) {
-        RedisTemplate<String, ExpiringSession> template = new RedisTemplate<String, ExpiringSession>();
-        template.setKeySerializer(new StringRedisSerializer());
-        template.setHashKeySerializer(new StringRedisSerializer());
-        template.setConnectionFactory(connectionFactory);
-        return template;
-    }
-
-    @Bean
-    public RedisOperationsSessionRepository sessionRepository(RedisTemplate<String, ExpiringSession> redisTemplate) {
-        return new RedisOperationsSessionRepository(redisTemplate);
-    }
-
-    @Bean
-    public <S extends ExpiringSession> SessionRepositoryFilter<? extends ExpiringSession> sessionFilter(SessionRepository<S> sessionRepository) {
-        return new SessionRepositoryFilter<S>(sessionRepository);
-    }
 }
 
 ----
@@ -208,7 +190,7 @@ public class Initializer extends AbstractContextLoaderInitializer {
     @Override
     public void onStartup(ServletContext servletContext) throws ServletException {
         super.onStartup(servletContext);
-        servletContext.addFilter("sessionFilter", DelegatingFilterProxy.class)
+        servletContext.addFilter("springSessionFilter", DelegatingFilterProxy.class)
                 .addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, "/*");
     }
 

samples/web/src/main/java/Config.java

@@ -18,14 +18,8 @@ import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
-import org.springframework.data.redis.core.RedisTemplate;
-import org.springframework.data.redis.serializer.StringRedisSerializer;
-import org.springframework.session.ExpiringSession;
-import org.springframework.session.SessionRepository;
-import org.springframework.session.data.redis.RedisOperationsSessionRepository;
-import org.springframework.session.web.http.SessionRepositoryFilter;
+import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;
 
 import redis.clients.jedis.Protocol;
 import redis.embedded.RedisServer;
@@ -34,8 +28,14 @@ import redis.embedded.RedisServer;
  * @author Rob Winch
  */
 @Configuration
+@EnableRedisHttpSession
 public class Config {
 
+    @Bean
+    public JedisConnectionFactory connectionFactory() throws Exception {
+        return new JedisConnectionFactory();
+    }
+
     @Bean
     public RedisServerBean redisServer() {
         return new RedisServerBean();
@@ -58,28 +58,4 @@ public class Config {
             }
         }
     }
-
-    @Bean
-    public JedisConnectionFactory connectionFactory() throws Exception {
-        return new JedisConnectionFactory();
-    }
-
-    @Bean
-    public RedisTemplate<String,ExpiringSession> redisTemplate(RedisConnectionFactory connectionFactory) {
-        RedisTemplate<String, ExpiringSession> template = new RedisTemplate<String, ExpiringSession>();
-        template.setKeySerializer(new StringRedisSerializer());
-        template.setHashKeySerializer(new StringRedisSerializer());
-        template.setConnectionFactory(connectionFactory);
-        return template;
-    }
-
-    @Bean
-    public RedisOperationsSessionRepository sessionRepository(RedisTemplate<String, ExpiringSession> redisTemplate) {
-        return new RedisOperationsSessionRepository(redisTemplate);
-    }
-
-    @Bean
-    public <S extends ExpiringSession> SessionRepositoryFilter<? extends ExpiringSession> sessionFilter(SessionRepository<S> sessionRepository) {
-        return new SessionRepositoryFilter<S>(sessionRepository);
-    }
 }

samples/web/src/main/java/Initializer.java

@@ -29,17 +29,17 @@ import java.util.EnumSet;
  * @author Rob Winch
  */
 public class Initializer extends AbstractContextLoaderInitializer {
-	@Override
-	public void onStartup(ServletContext servletContext) throws ServletException {
-		super.onStartup(servletContext);
-		servletContext.addFilter("sessionFilter", DelegatingFilterProxy.class)
-				.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, "/*");
-	}
+    @Override
+    public void onStartup(ServletContext servletContext) throws ServletException {
+        super.onStartup(servletContext);
+        servletContext.addFilter("springSessionRepositoryFilter", DelegatingFilterProxy.class)
+                .addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, "/*");
+    }
 
-	@Override
-	protected WebApplicationContext createRootApplicationContext() {
-		AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
-		context.register(Config.class);
-		return context;
-	}
+    @Override
+    protected WebApplicationContext createRootApplicationContext() {
+        AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
+        context.register(Config.class);
+        return context;
+    }
 }

spring-session/build.gradle

@@ -10,7 +10,8 @@ configurations {
 }
 
 dependencies {
-    optional "org.springframework.data:spring-data-redis:$springDataRedisVersion"
+    optional "org.springframework.data:spring-data-redis:$springDataRedisVersion",
+            "org.springframework:spring-context:$springVersion"
     provided "javax.servlet:javax.servlet-api:$servletApiVersion"
     integrationTestCompile "redis.clients:jedis:2.4.1",
             "org.apache.commons:commons-pool2:2.2",

spring-session/src/main/java/org/springframework/session/data/redis/config/annotation/web/http/EnableRedisHttpSession.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2002-2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.session.data.redis.config.annotation.web.http;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+
+/**
+ * Add this annotation to an {@code @Configuration} class to expose the
+ * SessionRepositoryFilter as a bean named "springSessionRepositoryFilter" and
+ * backed by Redis. In order to leverage the annotation, a single {@link RedisConnectionFactory}
+ * must be provided. For example:
+ *
+ * <code>
+ * &#064;Configuration
+ * &#064;EnableRedisHttpSession
+ * public class RedisHttpSessionConfig {
+ *
+ *     @Bean
+ *     public JedisConnectionFactory connectionFactory() throws Exception {
+ *         return new JedisConnectionFactory();
+ *     }
+ *
+ * }
+ * </code>
+ *
+ * More advanced configurations can extend {@link RedisHttpSessionConfiguration} instead.
+ *
+ * @author Rob Winch
+ * @since 1.0
+ */
+@Retention(value=java.lang.annotation.RetentionPolicy.RUNTIME)
+@Target(value={java.lang.annotation.ElementType.TYPE})
+@Documented
+@Import(RedisHttpSessionConfiguration.class)
+@Configuration
+public @interface EnableRedisHttpSession {}

spring-session/src/main/java/org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2002-2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.session.data.redis.config.annotation.web.http;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.data.redis.serializer.StringRedisSerializer;
+import org.springframework.session.ExpiringSession;
+import org.springframework.session.SessionRepository;
+import org.springframework.session.data.redis.RedisOperationsSessionRepository;
+import org.springframework.session.web.http.SessionRepositoryFilter;
+
+/**
+ * Exposes the {@link SessionRepositoryFilter} as a bean named
+ * "springSessionRepositoryFilter". In order to use this a single
+ * {@link RedisConnectionFactory} must be exposed as a Bean.
+ *
+ * @author Rob Winch
+ * @since 1.0
+ *
+ * @see EnableRedisHttpSession
+ */
+@Configuration
+public class RedisHttpSessionConfiguration {
+
+    @Bean
+    public RedisTemplate<String,ExpiringSession> redisTemplate(RedisConnectionFactory connectionFactory) {
+        RedisTemplate<String, ExpiringSession> template = new RedisTemplate<String, ExpiringSession>();
+        template.setKeySerializer(new StringRedisSerializer());
+        template.setHashKeySerializer(new StringRedisSerializer());
+        template.setConnectionFactory(connectionFactory);
+        return template;
+    }
+
+    @Bean
+    public RedisOperationsSessionRepository sessionRepository(RedisTemplate<String, ExpiringSession> redisTemplate) {
+        return new RedisOperationsSessionRepository(redisTemplate);
+    }
+
+    @Bean
+    public <S extends ExpiringSession> SessionRepositoryFilter<? extends ExpiringSession> springSessionRepositoryFilter(SessionRepository<S> sessionRepository) {
+        return new SessionRepositoryFilter<S>(sessionRepository);
+    }
+}