Add actuator endpoint to find and delete sessions

See gh-407

Author: eddumelendez

settings.gradle

@@ -28,3 +28,4 @@ include 'spring-session-data-gemfire'
 include 'spring-session-data-redis'
 include 'spring-session-jdbc'
 include 'spring-session-data-mongo'
+include 'spring-session-boot'

spring-session-boot/build.gradle

@@ -0,0 +1,31 @@
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        classpath("org.springframework.boot:spring-boot-gradle-plugin:$springBootVersion")
+    }
+}
+
+apply from: JAVA_GRADLE
+apply plugin: 'spring-io'
+
+description = "Aggregator for Spring Session and Spring Boot"
+
+dependencies {
+    compile project(':spring-session')
+    optional "org.springframework.boot:spring-boot-actuator",
+            "org.springframework.boot:spring-boot-starter-jdbc",
+            "org.springframework.boot:spring-boot-starter-web"
+
+    testCompile "org.springframework.boot:spring-boot-starter-test",
+                "com.h2database:h2"
+}
+
+dependencyManagement {
+    springIoTestRuntime {
+        imports {
+            mavenBom "io.spring.platform:platform-bom:${springIoVersion}"
+        }
+    }
+}

spring-session-boot/src/main/java/org/springframework/session/endpoint/EndpointConfiguration.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2014-2016 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.endpoint;
+
+import org.springframework.boot.actuate.endpoint.Endpoint;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.session.FindByIndexNameSessionRepository;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for session management
+ * {@link Endpoint}s.
+ *
+ * @author Eddú Meléndez
+ * @since 1.2.0
+ */
+@Configuration
+@ConditionalOnBean(FindByIndexNameSessionRepository.class)
+public class EndpointConfiguration {
+
+	@Bean
+	public SessionEndpoint sessionEndpoint() {
+		return new SessionEndpoint();
+	}
+
+}

spring-session-boot/src/main/java/org/springframework/session/endpoint/SessionEndpoint.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2014-2016 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.endpoint;
+
+import java.util.Collection;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.endpoint.Endpoint;
+import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
+import org.springframework.session.ExpiringSession;
+import org.springframework.session.FindByIndexNameSessionRepository;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+/**
+ * {@link MvcEndpoint} to expose actuator session.
+ *
+ * @author Eddú Meléndez
+ * @since 1.2.0
+ */
+public class SessionEndpoint implements MvcEndpoint {
+
+	@Autowired
+	private FindByIndexNameSessionRepository<? extends ExpiringSession> sessionRepository;
+
+	@RequestMapping(path = "/{username}", method = RequestMethod.GET)
+	public Collection<? extends ExpiringSession> result(@PathVariable String username) {
+		return this.sessionRepository.findByIndexNameAndIndexValue(
+				FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME, username)
+				.values();
+	}
+
+	@RequestMapping(path = "/{sessionId}", method = RequestMethod.DELETE)
+	public void delete(@PathVariable String sessionId) {
+		this.sessionRepository.delete(sessionId);
+	}
+
+	public String getPath() {
+		return "/session";
+	}
+
+	public boolean isSensitive() {
+		return true;
+	}
+
+	public Class<? extends Endpoint> getEndpointType() {
+		return Endpoint.class;
+	}
+
+}

spring-session-boot/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.actuate.autoconfigure.ManagementContextConfiguration=\
+org.springframework.session.endpoint.EndpointConfiguration

spring-session-boot/src/test/java/org/springframework/session/endpoint/SessionEndpointTests.java

@@ -0,0 +1,88 @@
+package org.springframework.session.endpoint;/*
+ * Copyright 2014-2016 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.
+ */
+
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.hamcrest.core.Is.is;
+import static org.junit.Assert.assertThat;
+
+import org.junit.After;
+import org.junit.Test;
+
+import org.springframework.boot.actuate.autoconfigure.EndpointWebMvcAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.ManagementServerProperties;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.session.FindByIndexNameSessionRepository;
+import org.springframework.session.SessionRepository;
+import org.springframework.session.jdbc.JdbcOperationsSessionRepository;
+import org.springframework.transaction.PlatformTransactionManager;
+import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
+
+import javax.sql.DataSource;
+
+/**
+ * Tests for {@link SessionEndpoint}.
+ *
+ * @author Eddú Meléndez
+ */
+public class SessionEndpointTests {
+
+	private AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext();
+
+	@After
+	public void close() {
+		if (this.applicationContext != null) {
+			this.applicationContext.close();
+		}
+	}
+
+	@Test
+	public void test() {
+		this.applicationContext.register(EmbeddedDataSourceConfiguration.class,
+				DataSourceTransactionManagerAutoConfiguration.class,
+				ManagementServerProperties.class, SessionAutoConfiguration.class,
+				EndpointConfiguration.class, EndpointWebMvcAutoConfiguration.class);
+		this.applicationContext.refresh();
+		FindByIndexNameSessionRepository sessionRepository = this.applicationContext
+				.getBean(FindByIndexNameSessionRepository.class);
+		assertThat(sessionRepository, is(notNullValue()));
+	}
+
+	@Test
+	public void test2() {
+		this.applicationContext.register(EmbeddedDataSourceConfiguration.class,
+				DataSourceTransactionManagerAutoConfiguration.class,
+				ManagementServerProperties.class, EndpointConfiguration.class,
+				EndpointWebMvcAutoConfiguration.class);
+		this.applicationContext.refresh();
+		String[] sessionRepository = this.applicationContext
+				.getBeanNamesForType(FindByIndexNameSessionRepository.class);
+		assertThat(sessionRepository.length, is(0));
+	}
+
+	@Configuration
+	static class SessionAutoConfiguration {
+
+		@Bean
+		public FindByIndexNameSessionRepository sessionRepository(DataSource dataSource,
+		                                                          PlatformTransactionManager transactionManager) {
+			return new JdbcOperationsSessionRepository(dataSource, transactionManager);
+		}
+	}
+
+}