Added auto-configuration for Spring Boot

README.md

@@ -11,6 +11,7 @@
 * [Enabling Session Replication in Multi-App Environments](#enabling-session-replication-in-multi-app-environments)
 * [Sticky Sessions and Tomcat](#sticky-sessions-and-tomcat)
 * [Tomcat Failover and the jvmRoute Parameter](#tomcatfailover-and-the-jvmroute-parameter)
+* [Spring Boot Auto-configuration](#spring-boot-auto-configuration)
 
 
 # Tomcat Based Web Session Replication
@@ -243,5 +244,23 @@ When Tomcat Failure happens and Load Balancer cannot redirect the request to the
  <Engine name="Catalina" defaultHost="localhost" jvmRoute="tomcat-8080">
 ```
 
+# Spring Boot Auto-configuration
+
+Starting with v2.2, Hazelcast Tomcat Session Manager supports auto-configuration when used with Spring Boot. The only thing you need to do is to add Hazelcast Tomcat Session Manager (for Tomcat 9) library to the classpath. This will set Hazelcast Session Manager as the session manager of the Tomcat. If you would like to configure the session manager properties, you can setup the following properties in your `application.properties` file:
+
+- `tsm.hazelcast.config.location`: Allows to provide Hazelcast member configuration. If not provided, `hazelcast.xml` in the classpath is used by default. Only works if `tsm.client.only` is **not** to set true. 
+- `tsm.hazelcast.client.config.location`: Allows to provide Hazelcast client configuration. If not provided, `hazelcast-client.xml` in the classpath is used by default. Only works if `tsm.client.only` is to set true.
+- `tsm.client.only`: When set to `true`, Hazelcast Session Manager initializes in client-only mode and tries to connect to a Hazelcast cluster using the provided configuration.
+- `tsm.map.name`: Use this property if you have a specially configured map for special cases like WAN Replication, Eviction, MapStore, etc.
+- `tsm.sticky`: Allows to set sticky mode. Its default value is `true`.
+- `tsm.process.expires.frequency`: It specifies the frequency of session validity check, in seconds. Its default value is 6 and the minimum value that you can set is 1.
+- `tsm.deferred.write`: Allows to set deferred write mode. See [this section](#controlling-session-caching-with-deferredWrite) for details.
+- `tsm.hazelcast.instance.name`: It specifies an existing Hazelcast instance to use for session replication. The same can be achieved by setting `instanceName` property in Hazelcast configuration. If no instance name is configured, Hazelcast instance starts with a default instance name (`SessionManager.DEFAULT_INSTANCE_NAME`).
+
+## Notes about Spring Boot Auto-configuration
+
+- If a `com.hazelcast.client.config.ClientConfig` bean is configured explicitly, then `ClientServerLifecycleListener.setConfig(clientConfig);` should be called to enable this configuration to be used in Hazelcast Session Manager.
+- If a `com.hazelcast.config.Config` bean is configured explicitly, then both `hazelcastInstance` configuration and `tsm.hazelcast.instance.name` property should be set. 
+
 # License
 Hazelcast Tomcat Session Manager is available under the Hazelcast Community License. 

tomcat-core/pom.xml

@@ -36,6 +36,18 @@
             <version>${tomcat-version}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <version>2.2.1.RELEASE</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>2.2.1.RELEASE</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.esotericsoftware</groupId>
             <artifactId>kryo</artifactId>

tomcat-core/src/main/java/com/hazelcast/session/ClientServerConfigLoader.java

@@ -28,16 +28,16 @@
 
 import static com.hazelcast.internal.config.ConfigLoader.locateConfig;
 
-class ClientServerConfigLoader {
+public class ClientServerConfigLoader {
     private ConfigRecognizer xmlConfigRecognizer;
     private ConfigRecognizer yamlConfigRecognizer;
 
-    ClientServerConfigLoader() throws Exception {
+    public ClientServerConfigLoader() throws Exception {
         xmlConfigRecognizer = new ClientXmlConfigRootTagRecognizer();
         yamlConfigRecognizer = new ClientYamlConfigRootTagRecognizer();
     }
 
-    ClientConfig load(final String path) throws Exception {
+    public ClientConfig load(final String path) throws Exception {
         final URL url = locateConfig(path);
         if (url == null) {
             return null;

tomcat-core/src/main/java/com/hazelcast/session/ClientServerLifecycleListener.java

@@ -55,6 +55,10 @@ public void setConfigLocation(String configLocation) {
         this.configLocation = configLocation;
     }
 
+    public static void setConfig(ClientConfig config) {
+        ClientServerLifecycleListener.config = config;
+    }
+
     public static ClientConfig getConfig() {
         return config;
     }

tomcat-core/src/main/java/com/hazelcast/session/P2PConfigLoader.java

@@ -28,16 +28,16 @@
 
 import static com.hazelcast.internal.config.ConfigLoader.locateConfig;
 
-class P2PConfigLoader {
+public class P2PConfigLoader {
     private ConfigRecognizer xmlConfigRecognizer;
     private ConfigRecognizer yamlConfigRecognizer;
 
-    P2PConfigLoader() throws Exception {
+    public P2PConfigLoader() throws Exception {
         xmlConfigRecognizer = new MemberXmlConfigRootTagRecognizer();
         yamlConfigRecognizer = new MemberYamlConfigRootTagRecognizer();
     }
 
-    Config load(final String path) throws Exception {
+    public Config load(final String path) throws Exception {
         final URL url = locateConfig(path);
         if (url == null) {
             return null;

tomcat9/pom.xml

@@ -93,6 +93,18 @@
             <version>${tomcat-version}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <version>2.4.1</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>2.4.1</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.esotericsoftware</groupId>
             <artifactId>kryo</artifactId>

tomcat9/src/main/java/com/hazelcast/session/springboot/HazelcastSessionManagerConfiguration.java

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2020 Hazelcast Inc.
+ *
+ * Licensed under the Hazelcast Community License (the "License"); you may not use
+ * this file except in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://hazelcast.com/hazelcast-community-license
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.hazelcast.session.springboot;
+
+import com.hazelcast.client.config.ClientConfig;
+import com.hazelcast.config.Config;
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.session.ClientServerConfigLoader;
+import com.hazelcast.session.ClientServerLifecycleListener;
+import com.hazelcast.session.HazelcastSessionManager;
+import com.hazelcast.session.P2PConfigLoader;
+import com.hazelcast.session.SessionManager;
+import org.apache.catalina.Context;
+import org.apache.juli.logging.Log;
+import org.apache.juli.logging.LogFactory;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.web.embedded.tomcat.TomcatContextCustomizer;
+import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
+import org.springframework.boot.web.server.WebServerFactoryCustomizer;
+import org.springframework.context.annotation.Bean;
+
+@org.springframework.context.annotation.Configuration
+@ConditionalOnClass(HazelcastSessionManager.class)
+public class HazelcastSessionManagerConfiguration {
+    private final Log log = LogFactory.getLog(HazelcastSessionManager.class);
+
+    @Value("${tsm.hazelcast.config.location:hazelcast-default.xml}")
+    private String configLocation;
+    @Value("${tsm.hazelcast.client.config.location:hazelcast-client-default.xml}")
+    private String clientConfigLocation;
+    @Value("${tsm.client.only:false}")
+    private boolean clientOnly;
+    @Value("${tsm.map.name:default}")
+    private String mapName;
+    @Value("${tsm.sticky:true}")
+    private boolean sticky;
+    @Value("${tsm.process.expires.frequency:6}")
+    private int processExpiresFrequency;
+    @Value("${tsm.deferred.write:true}")
+    private boolean deferredWrite;
+    @Value("${tsm.hazelcast.instance.name:" + SessionManager.DEFAULT_INSTANCE_NAME + "}")
+    private String hazelcastInstanceName;
+
+    @Bean
+    @ConditionalOnMissingBean(type = "com.hazelcast.config.Config")
+    @ConditionalOnProperty(name = "tsm.client.only", havingValue = "false", matchIfMissing = true)
+    public Config hazelcastConfig() throws Exception {
+        Config config = new P2PConfigLoader().load(configLocation);
+        if (config.getInstanceName() == null) {
+            config.setInstanceName(SessionManager.DEFAULT_INSTANCE_NAME);
+        }
+        return config;
+    }
+
+    @Bean
+    @ConditionalOnMissingBean(type = "com.hazelcast.client.config.ClientConfig")
+    @ConditionalOnProperty(name = "tsm.client.only", havingValue = "true")
+    public ClientConfig hazelcastClientConfig() throws Exception {
+        ClientConfig clientConfig = new ClientServerConfigLoader().load(clientConfigLocation);
+        ClientServerLifecycleListener.setConfig(clientConfig);
+        return clientConfig;
+    }
+
+    @Bean(name = "hazelcastTomcatSessionManagerCustomizer")
+    public WebServerFactoryCustomizer<TomcatServletWebServerFactory> customizeTomcat(HazelcastInstance hazelcastInstance) {
+        return new WebServerFactoryCustomizer<TomcatServletWebServerFactory>() {
+            @Override
+            public void customize(TomcatServletWebServerFactory factory) {
+                factory.addContextCustomizers(new TomcatContextCustomizer() {
+                    @Override
+                    public void customize(Context context) {
+                        HazelcastSessionManager manager = new HazelcastSessionManager();
+                        manager.setClientOnly(clientOnly);
+                        manager.setMapName(mapName);
+                        manager.setSticky(sticky);
+                        manager.setProcessExpiresFrequency(processExpiresFrequency);
+                        manager.setDeferredWrite(deferredWrite);
+                        manager.setHazelcastInstanceName(hazelcastInstanceName);
+                        context.setManager(manager);
+                        log.info(String.format(
+                                "Tomcat context is configured with HazelcastSessionManager => clientOnly: %s, mapName: %s, "
+                                        + "isSticky: %s, processExpiresFrequency: %d, deferredWrite: %s, "
+                                        + "hazelcastInstanceName: %s",
+                                clientOnly, mapName, sticky, processExpiresFrequency, deferredWrite, hazelcastInstanceName));
+                    }
+                });
+            }
+        };
+    }
+}

tomcat9/src/main/java/com/hazelcast/session/springboot/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2020 Hazelcast Inc.
+ *
+ * Licensed under the Hazelcast Community License (the "License"); you may not use
+ * this file except in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://hazelcast.com/hazelcast-community-license
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+/**
+ * This package provides Spring Boot auto-configuration classes
+ */
+package com.hazelcast.session.springboot;

tomcat9/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration= \
+ com.hazelcast.session.springboot.HazelcastSessionManagerConfiguration

tomcat9/src/test/java/com/hazelcast/session/springboot/AbstractSpringBootConfigurationTest.java

@@ -0,0 +1,46 @@
+package com.hazelcast.session.springboot;
+
+import com.hazelcast.core.DistributedObject;
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.map.IMap;
+import org.apache.http.client.CookieStore;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.impl.client.BasicCookieStore;
+import org.apache.http.impl.client.HttpClientBuilder;
+import org.junit.Test;
+import org.springframework.context.ApplicationContext;
+
+import java.util.LinkedList;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public abstract class AbstractSpringBootConfigurationTest {
+    ApplicationContext applicationContext;
+
+    abstract void setup();
+
+    abstract void clean();
+
+    @Test()
+    public void testManagerCustomizerBean() {
+        assertNotNull(applicationContext.getBean("hazelcastTomcatSessionManagerCustomizer"));
+    }
+
+    @Test()
+    public void testSessionManager()
+            throws Exception {
+        HazelcastInstance hazelcastInstance = (HazelcastInstance) applicationContext.getBean("hazelcastInstance");
+        LinkedList<DistributedObject> distributedObjects = (LinkedList<DistributedObject>) hazelcastInstance.getDistributedObjects();
+        assertEquals("Session map should be created.", 1, distributedObjects.size());
+
+        CookieStore cookieStore = new BasicCookieStore();
+        HttpClient client = HttpClientBuilder.create().setDefaultCookieStore(cookieStore).build();
+        HttpGet request = new HttpGet("http://localhost:9999/set");
+        client.execute(request);
+
+        IMap<Object, Object> sessionMap = hazelcastInstance.getMap(distributedObjects.get(0).getName());
+        assertEquals("Session should be created.",1, sessionMap.size());
+    }
+}

tomcat9/src/test/java/com/hazelcast/session/springboot/ClientServerApplication.java

@@ -0,0 +1,13 @@
+package com.hazelcast.session.springboot;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.PropertySource;
+
+@SpringBootApplication
+@PropertySource("classpath:clientServer.properties")
+public class ClientServerApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(ClientServerApplication.class, args);
+    }
+}

tomcat9/src/test/java/com/hazelcast/session/springboot/ClientServerSpringBootConfigurationTest.java

@@ -0,0 +1,25 @@
+package com.hazelcast.session.springboot;
+
+import com.hazelcast.core.Hazelcast;
+import com.hazelcast.core.HazelcastInstance;
+import org.junit.After;
+import org.junit.Before;
+import org.springframework.boot.SpringApplication;
+
+public class ClientServerSpringBootConfigurationTest
+        extends AbstractSpringBootConfigurationTest {
+
+    private HazelcastInstance hazelcastInstance;
+
+    @Before
+    public void setup() {
+        hazelcastInstance = Hazelcast.newHazelcastInstance();
+        applicationContext = SpringApplication.run(ClientServerApplication.class);
+    }
+
+    @After
+    public void clean() {
+        SpringApplication.exit(applicationContext);
+        hazelcastInstance.shutdown();
+    }
+}

tomcat9/src/test/java/com/hazelcast/session/springboot/P2PApplication.java

@@ -0,0 +1,15 @@
+package com.hazelcast.session.springboot;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.FilterType;
+
+@SpringBootApplication
+@ComponentScan(excludeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,
+        classes = ClientServerApplication.class))
+public class P2PApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(P2PApplication.class, args);
+    }
+}

tomcat9/src/test/java/com/hazelcast/session/springboot/P2PSpringBootConfigurationTest.java

@@ -0,0 +1,20 @@
+package com.hazelcast.session.springboot;
+
+import org.junit.After;
+import org.junit.Before;
+import org.springframework.boot.SpringApplication;
+
+public class P2PSpringBootConfigurationTest
+        extends AbstractSpringBootConfigurationTest {
+
+    @Before
+    public void setup() {
+        applicationContext = SpringApplication.run(P2PApplication.class);
+    }
+
+    @After
+    public void clean() {
+        SpringApplication.exit(applicationContext);
+    }
+
+}

tomcat9/src/test/java/com/hazelcast/session/springboot/TestController.java

@@ -0,0 +1,15 @@
+package com.hazelcast.session.springboot;
+
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import javax.servlet.http.HttpSession;
+
+@RestController
+public class TestController {
+
+    @RequestMapping("/set")
+    public void defaultMapping(HttpSession session){
+        session.setAttribute("testAttr", 1);
+    }
+}

tomcat9/src/test/resources/application.properties

@@ -0,0 +1,2 @@
+logging.level.root=INFO
+server.port=9999