diff --git a/src/main/java/org/springframework/session/data/mongo/EnableMongoWebSession.java b/src/main/java/org/springframework/session/data/mongo/EnableMongoWebSession.java new file mode 100644 index 0000000..476d7a8 --- /dev/null +++ b/src/main/java/org/springframework/session/data/mongo/EnableMongoWebSession.java @@ -0,0 +1,56 @@ +/* + * Copyright 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.session.data.mongo; + +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.session.EnableSpringWebSession; + +/** + * Add this annotation to a {@code @Configuration} class to configure a MongoDB-based {@code WebSessionManager} for a + * WebFlux application. This annotation assumes a {@code ReactorMongoOperations} is defined somewhere in the application + * context. If not, it will fail with a clear error messages. For example: + * + *
+ *
+ * {@literal @Configuration}
+ * {@literal @EnableMongoWebSession}
+ * public class SpringWebFluxConfig {
+ *
+ * {@literal @Bean}
+ * public ReactorMongoOperations operations() {
+ * return new MaReactorMongoOperations(...);
+ * }
+ *
+ * }
+ *
+ *
+ *
+ * @author Greg Turnquist
+ * @since 2.0
+ */
+@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
+@Target({ java.lang.annotation.ElementType.TYPE })
+@Documented
+@EnableSpringWebSession
+@Import(ReactiveMongoWebSessionConfiguration.class)
+@Configuration
+public @interface EnableMongoWebSession {
+}
diff --git a/src/main/java/org/springframework/session/data/mongo/ReactiveMongoWebSessionConfiguration.java b/src/main/java/org/springframework/session/data/mongo/ReactiveMongoWebSessionConfiguration.java
new file mode 100644
index 0000000..e24ba25
--- /dev/null
+++ b/src/main/java/org/springframework/session/data/mongo/ReactiveMongoWebSessionConfiguration.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright 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.session.data.mongo;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.core.ReactiveMongoOperations;
+
+/**
+ * Configure a {@link ReactiveMongoOperationsSessionRepository} using a provided {@link ReactiveMongoOperations}.
+ *
+ * @author Greg Turnquist
+ */
+@Configuration
+public class ReactiveMongoWebSessionConfiguration {
+
+ @Bean
+ public ReactiveMongoOperationsSessionRepository reactiveMongoOperationsSessionRepository(ReactiveMongoOperations operations) {
+ return new ReactiveMongoOperationsSessionRepository(operations);
+ }
+}
diff --git a/src/test/java/org/springframework/session/data/mongo/ReactiveMongoWebSessionConfigurationTests.java b/src/test/java/org/springframework/session/data/mongo/ReactiveMongoWebSessionConfigurationTests.java
new file mode 100644
index 0000000..cb059b3
--- /dev/null
+++ b/src/test/java/org/springframework/session/data/mongo/ReactiveMongoWebSessionConfigurationTests.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright 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.session.data.mongo;
+
+import static org.assertj.core.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import org.junit.Test;
+import org.springframework.beans.factory.UnsatisfiedDependencyException;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.data.mongodb.core.ReactiveMongoOperations;
+import org.springframework.session.EnableSpringWebSession;
+import org.springframework.session.ReactorSessionRepository;
+import org.springframework.web.server.adapter.WebHttpHandlerBuilder;
+import org.springframework.web.server.session.WebSessionManager;
+
+/**
+ * Verify various configurations through {@link EnableSpringWebSession}.
+ *
+ * @author Greg Turnquist
+ */
+public class ReactiveMongoWebSessionConfigurationTests {
+
+ @Test
+ public void enableSpringWebSessionConfiguresThings() {
+
+ AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+ ctx.register(GoodConfig.class);
+ ctx.refresh();
+
+ WebSessionManager webSessionManagerFoundByType = ctx.getBean(WebSessionManager.class);
+ Object webSessionManagerFoundByName = ctx.getBean(WebHttpHandlerBuilder.WEB_SESSION_MANAGER_BEAN_NAME);
+
+ assertThat(webSessionManagerFoundByType).isNotNull();
+ assertThat(webSessionManagerFoundByName).isNotNull();
+ assertThat(webSessionManagerFoundByType).isEqualTo(webSessionManagerFoundByName);
+
+ assertThat(ctx.getBean(ReactorSessionRepository.class)).isNotNull();
+ }
+
+ @Test
+ public void missingReactorSessionRepositoryBreaksAppContext() {
+
+ AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
+ ctx.register(BadConfig.class);
+
+ assertThatExceptionOfType(UnsatisfiedDependencyException.class)
+ .isThrownBy(ctx::refresh)
+ .withMessageContaining("Error creating bean with name 'webSessionManager'")
+ .withMessageContaining("No qualifying bean of type '" + ReactiveMongoOperations.class.getCanonicalName());
+ }
+
+ /**
+ * A configuration with all the right parts.
+ */
+ @EnableMongoWebSession
+ static class GoodConfig {
+
+ @Bean
+ ReactiveMongoOperations operations() {
+ return mock(ReactiveMongoOperations.class);
+ }
+ }
+
+ /**
+ * A configuration where no {@link ReactiveMongoOperations} is defined. It's BAD!
+ */
+ @EnableMongoWebSession
+ static class BadConfig {
+
+ }
+}