Reinstate Spring Session MongoDB auto-config

Author: vpavic

spring-boot-autoconfigure/pom.xml

@@ -531,6 +531,11 @@
 			<artifactId>spring-session-core</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.session</groupId>
+			<artifactId>spring-session-data-mongodb</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.session</groupId>
 			<artifactId>spring-session-data-redis</artifactId>

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/MongoSessionConfiguration.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2012-2017 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.boot.autoconfigure.session;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Conditional;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.session.SessionRepository;
+import org.springframework.session.data.mongo.config.annotation.web.http.MongoHttpSessionConfiguration;
+
+/**
+ * MongoDB backed session configuration.
+ *
+ * @author Eddú Meléndez
+ * @author Stephane Nicoll
+ * @author Vedran Pavic
+ */
+@Configuration
+@ConditionalOnMissingBean(SessionRepository.class)
+@ConditionalOnBean(MongoOperations.class)
+@Conditional(SessionCondition.class)
+@EnableConfigurationProperties(MongoSessionProperties.class)
+class MongoSessionConfiguration {
+
+	@Configuration
+	public static class SpringBootMongoHttpSessionConfiguration
+			extends MongoHttpSessionConfiguration {
+
+		@Autowired
+		public void customize(SessionProperties sessionProperties,
+				MongoSessionProperties mongoSessionProperties) {
+			Integer timeout = sessionProperties.getTimeout();
+			if (timeout != null) {
+				setMaxInactiveIntervalInSeconds(timeout);
+			}
+			setCollectionName(mongoSessionProperties.getCollectionName());
+		}
+
+	}
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/MongoSessionProperties.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2012-2017 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.boot.autoconfigure.session;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Configuration properties for MongoDB backed Spring Session.
+ *
+ * @author Vedran Pavic
+ * @since 2.0.0
+ */
+@ConfigurationProperties(prefix = "spring.session.mongodb")
+public class MongoSessionProperties {
+
+	/**
+	 * Collection name used to store sessions.
+	 */
+	private String collectionName = "sessions";
+
+	public String getCollectionName() {
+		return this.collectionName;
+	}
+
+	public void setCollectionName(String collectionName) {
+		this.collectionName = collectionName;
+	}
+
+}

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java

@@ -29,6 +29,7 @@
 import org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration;
+import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
 import org.springframework.boot.autoconfigure.session.SessionAutoConfiguration.SessionConfigurationImportSelector;
 import org.springframework.boot.autoconfigure.session.SessionAutoConfiguration.SessionRepositoryValidator;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -55,7 +56,8 @@
 @ConditionalOnWebApplication(type = Type.SERVLET)
 @EnableConfigurationProperties(SessionProperties.class)
 @AutoConfigureAfter({ DataSourceAutoConfiguration.class, HazelcastAutoConfiguration.class,
-		JdbcTemplateAutoConfiguration.class, RedisAutoConfiguration.class })
+		JdbcTemplateAutoConfiguration.class, MongoAutoConfiguration.class,
+		RedisAutoConfiguration.class })
 @Import({ SessionConfigurationImportSelector.class, SessionRepositoryValidator.class,
 		SessionRepositoryFilterConfiguration.class })
 public class SessionAutoConfiguration {

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionStoreMappings.java

@@ -35,6 +35,7 @@ final class SessionStoreMappings {
 	static {
 		Map<StoreType, Class<?>> mappings = new HashMap<>();
 		mappings.put(StoreType.REDIS, RedisSessionConfiguration.class);
+		mappings.put(StoreType.MONGODB, MongoSessionConfiguration.class);
 		mappings.put(StoreType.JDBC, JdbcSessionConfiguration.class);
 		mappings.put(StoreType.HAZELCAST, HazelcastSessionConfiguration.class);
 		mappings.put(StoreType.HASH_MAP, HashMapSessionConfiguration.class);

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/StoreType.java

@@ -31,6 +31,11 @@ public enum StoreType {
 	 */
 	REDIS,
 
+	/**
+	 * MongoDB backed sessions.
+	 */
+	MONGODB,
+
 	/**
 	 * JDBC backed sessions.
 	 */

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationMongoTests.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2012-2017 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.boot.autoconfigure.session;
+
+import java.util.Arrays;
+
+import org.junit.Test;
+
+import org.springframework.beans.DirectFieldAccessor;
+import org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration;
+import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
+import org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration;
+import org.springframework.session.data.mongo.MongoOperationsSessionRepository;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * MongoDB specific tests for {@link SessionAutoConfiguration}.
+ *
+ * @author Vedran Pavic
+ */
+public class SessionAutoConfigurationMongoTests
+		extends AbstractSessionAutoConfigurationTests {
+
+	@Test
+	public void mongoSessionStore() {
+		load(Arrays.asList(EmbeddedMongoAutoConfiguration.class,
+				MongoAutoConfiguration.class, MongoDataAutoConfiguration.class),
+				"spring.session.store-type=mongodb");
+		validateSessionRepository(MongoOperationsSessionRepository.class);
+	}
+
+	@Test
+	public void mongoSessionStoreWithCustomizations() {
+		load(Arrays.asList(EmbeddedMongoAutoConfiguration.class,
+				MongoAutoConfiguration.class, MongoDataAutoConfiguration.class),
+				"spring.session.store-type=mongodb",
+				"spring.session.mongodb.collection-name=foobar");
+		MongoOperationsSessionRepository repository = validateSessionRepository(
+				MongoOperationsSessionRepository.class);
+		assertThat(new DirectFieldAccessor(repository).getPropertyValue("collectionName"))
+				.isEqualTo("foobar");
+	}
+
+}

spring-boot-dependencies/pom.xml

@@ -170,6 +170,7 @@
 		<spring-security-jwt.version>1.0.8.RELEASE</spring-security-jwt.version>
 		<spring-security-oauth.version>2.1.2.BUILD-SNAPSHOT</spring-security-oauth.version>
 		<spring-session.version>2.0.0.BUILD-SNAPSHOT</spring-session.version>
+		<spring-session-mongodb.version>2.0.0.BUILD-SNAPSHOT</spring-session-mongodb.version>
 		<spring-social.version>2.0.0.M3</spring-social.version>
 		<spring-social-facebook.version>3.0.0.M2</spring-social-facebook.version>
 		<spring-social-linkedin.version>2.0.0.M2</spring-social-linkedin.version>
@@ -2318,6 +2319,11 @@
 					</exclusion>
 				</exclusions>
 			</dependency>
+			<dependency>
+				<groupId>org.springframework.session</groupId>
+				<artifactId>spring-session-data-mongodb</artifactId>
+				<version>${spring-session-mongodb.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>org.springframework.session</groupId>
 				<artifactId>spring-session-data-redis</artifactId>

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -419,6 +419,7 @@ content into your application; rather pick only the properties that you need.
 	spring.session.jdbc.initializer.enabled= # Create the required session tables on startup if necessary. Enabled automatically if the default table name is set or a custom schema is configured.
 	spring.session.jdbc.schema=classpath:org/springframework/session/jdbc/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
 	spring.session.jdbc.table-name=SPRING_SESSION # Name of database table used to store sessions.
+	spring.session.mongodb.collection-name=sessions # Collection name used to store sessions.
 	spring.session.redis.flush-mode=on-save # Sessions flush mode.
 	spring.session.redis.namespace= # Namespace for keys used to store sessions.
 	spring.session.store-type= # Session store type.

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -5280,6 +5280,7 @@ classes for more details.
 Spring Boot provides Spring Session auto-configuration for a wide range of stores:
 
 * JDBC
+* MongoDB
 * Redis
 * Hazelcast
 * HashMap