Add GemFire Support

Fixes GH PR #148 and PR #308 implementing a GemFire Adapter to support
clustered HttpSessions in Spring Session.

* Resolve SGF-373 - Implement a Spring Session Adapter for GemFire backing
a HttpSession similar to the Redis support.
* Add Spring Session annotation to enable GemFire support with
@EnableGemFireHttpSession.
* Add extesion of SpringHttpSessionConfiguration to configure GemFire using
GemFireHttpSessionConfiguration.
* Add implementation of SessionRepository to access clustered, replicated
HttpSession state in GemFire with GemFireOperationsSessionRepository.
* Utilize GemFire Data Serialization framework to both replicate
HttpSession state information as well as handle deltas.
* Utilize GemFire OQL query to lookup arbitrary Session attributes by name,
and in particular the user authenticated principal name.
* Implment unit and integration tests, and in particular, tests for both
peer-to-peer (p2p) and client/server topologies.
* Set initial Spring Data GemFire version to 1.7.2.RELEASE, which depends
on Pivotal GemFire 8.1.0.
* Add documentation, Javadoc and samples along with additional Integration
Tests.

Fixes gh-148

samples/httpsession-gemfire-clientserver/src/integration-test/groovy/sample/AttributeTests.groovy

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2002-2015 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 sample
+
+import geb.spock.*
+import sample.pages.HomePage;
+import spock.lang.Stepwise
+import pages.*
+
+/**
+ * Tests the CAS sample application using service tickets.
+ *
+ * @author Rob Winch
+ */
+@Stepwise
+class AttributeTests extends GebReportingSpec {
+	def 'first visit no attributes'() {
+		when:
+		to HomePage
+		then:
+		attributes.empty
+	}
+
+	def 'create attribute'() {
+		when:
+		createAttribute('a','b')
+		then:
+		attributes.size() == 1
+		attributes[0].name == 'a'
+		attributes[0].value == 'b'
+	}
+}

samples/httpsession-gemfire-clientserver/src/integration-test/groovy/sample/pages/HomePage.groovy

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2002-2015 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 sample.pages
+
+import geb.*
+
+/**
+ * The home page
+ *
+ * @author Rob Winch
+ */
+class HomePage extends Page {
+	static url = ''
+	static at = { assert driver.title == 'Session Attributes'; true}
+	static content = {
+		form { $('form') }
+		submit { $('input[type=submit]') }
+		createAttribute(required:false) { name, value ->
+			form.attributeName = name
+			form.attributeValue = value
+			submit.click(HomePage)
+		}
+		attributes { moduleList AttributeRow, $("table tr").tail() }
+	}
+}
+class AttributeRow extends Module {
+	static content = {
+		cell { $("td", it) }
+		name { cell(0).text() }
+		value { cell(1).text() }
+	}
+}

samples/httpsession-gemfire-clientserver/src/main/java/sample/ClientConfig.java

@@ -0,0 +1,204 @@
+/*
+ * Copyright 2002-2015 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 sample;
+
+import java.io.IOException;
+import java.net.Socket;
+import java.util.Collections;
+import java.util.Properties;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
+import org.springframework.data.gemfire.client.ClientCacheFactoryBean;
+import org.springframework.data.gemfire.client.PoolFactoryBean;
+import org.springframework.data.gemfire.config.GemfireConstants;
+import org.springframework.data.gemfire.support.ConnectionEndpoint;
+import org.springframework.session.data.gemfire.config.annotation.web.http.EnableGemFireHttpSession;
+import org.springframework.session.data.gemfire.support.GemFireUtils;
+import org.springframework.util.Assert;
+
+import com.gemstone.gemfire.cache.client.Pool;
+import com.gemstone.gemfire.management.membership.ClientMembership;
+import com.gemstone.gemfire.management.membership.ClientMembershipEvent;
+import com.gemstone.gemfire.management.membership.ClientMembershipListenerAdapter;
+
+// tag::class[]
+@EnableGemFireHttpSession(maxInactiveIntervalInSeconds = 30) // <1>
+public class ClientConfig {
+
+	static final long DEFAULT_WAIT_DURATION = TimeUnit.SECONDS.toMillis(20);
+	static final long DEFAULT_WAIT_INTERVAL = 500l;
+
+	static final CountDownLatch latch = new CountDownLatch(1);
+
+	static {
+		System.setProperty("gemfire.log-level",
+			System.getProperty("sample.httpsession.gemfire.log-level", "warning"));
+
+		ClientMembership.registerClientMembershipListener(
+			new ClientMembershipListenerAdapter() {
+				public void memberJoined(ClientMembershipEvent event) {
+					if (!event.isClient()) {
+						latch.countDown();
+					}
+				}
+		});
+	}
+
+	@Bean
+	PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
+		return new PropertySourcesPlaceholderConfigurer();
+	}
+
+	@Bean
+	Properties gemfireProperties() { // <2>
+		return new Properties();
+	}
+
+	@Bean(name = GemfireConstants.DEFAULT_GEMFIRE_POOL_NAME)
+	PoolFactoryBean gemfirePool( // <3>
+			@Value("${spring.session.data.gemfire.port:"+ServerConfig.SERVER_PORT+"}") int port) {
+
+		PoolFactoryBean poolFactory = new PoolFactoryBean();
+
+		poolFactory.setName(GemfireConstants.DEFAULT_GEMFIRE_POOL_NAME);
+		poolFactory.setFreeConnectionTimeout(5000); // 5 seconds
+		poolFactory.setKeepAlive(false);
+		poolFactory.setMaxConnections(ServerConfig.MAX_CONNECTIONS);
+		poolFactory.setPingInterval(TimeUnit.SECONDS.toMillis(5));
+		poolFactory.setReadTimeout(2000); // 2 seconds
+		poolFactory.setRetryAttempts(2);
+		poolFactory.setSubscriptionEnabled(true);
+		poolFactory.setThreadLocalConnections(false);
+
+		poolFactory.setServerEndpoints(Collections.singletonList(new ConnectionEndpoint(
+			ServerConfig.SERVER_HOSTNAME, port)));
+
+		return poolFactory;
+	}
+
+	@Bean
+	ClientCacheFactoryBean gemfireCache(Pool gemfirePool) { // <4>
+		ClientCacheFactoryBean clientCacheFactory = new ClientCacheFactoryBean();
+
+		clientCacheFactory.setClose(true);
+		clientCacheFactory.setProperties(gemfireProperties());
+		clientCacheFactory.setPool(gemfirePool);
+		clientCacheFactory.setUseBeanFactoryLocator(false);
+
+		return clientCacheFactory;
+	}
+
+	@Bean
+	BeanPostProcessor gemfireCacheServerReadyBeanPostProcessor( // <5>
+			@Value("${spring.session.data.gemfire.port:"+ServerConfig.SERVER_PORT+"}") final int port) {
+
+		return new BeanPostProcessor() {
+
+			public Object postProcessBeforeInitialization(
+					Object bean, String beanName) throws BeansException {
+				if (bean instanceof PoolFactoryBean || bean instanceof Pool) {
+					Assert.isTrue(waitForCacheServerToStart(ServerConfig.SERVER_HOSTNAME, port),
+						String.format("GemFire Server failed to start [hostname: %1$s, port: %2$d]",
+							ServerConfig.SERVER_HOSTNAME, port));
+				}
+
+				return bean;
+			}
+
+			public Object postProcessAfterInitialization(
+					Object bean, String beanName) throws BeansException {
+				if (bean instanceof PoolFactoryBean || bean instanceof Pool) {
+					try {
+						latch.await(DEFAULT_WAIT_DURATION,
+							TimeUnit.MILLISECONDS);
+					}
+					catch (InterruptedException e) {
+						Thread.currentThread().interrupt();
+					}
+				}
+
+				return bean;
+			}
+		};
+	}
+// end::class[]
+
+	interface Condition {
+		boolean evaluate();
+	}
+
+	boolean waitForCacheServerToStart(String host, int port) {
+		return waitForCacheServerToStart(host, port, DEFAULT_WAIT_DURATION);
+	}
+
+	/* (non-Javadoc) */
+	boolean waitForCacheServerToStart(final String host, final int port, long duration) {
+		return waitOnCondition(new Condition() {
+			AtomicBoolean connected = new AtomicBoolean(false);
+
+			public boolean evaluate() {
+				Socket socket = null;
+
+				try {
+					// NOTE: this code is not intended to be an atomic, compound action (a possible race condition);
+					// opening another connection (at the expense of using system resources) after connectivity
+					// has already been established is not detrimental in this use case
+					if (!connected.get()) {
+						socket = new Socket(host, port);
+						connected.set(true);
+					}
+				}
+				catch (IOException ignore) {
+				}
+				finally {
+					GemFireUtils.close(socket);
+				}
+
+				return connected.get();
+			}
+		}, duration);
+	}
+
+	@SuppressWarnings("unused")
+	boolean waitOnCondition(Condition condition) {
+		return waitOnCondition(condition, DEFAULT_WAIT_DURATION);
+	}
+
+	@SuppressWarnings("all")
+	boolean waitOnCondition(Condition condition, long duration) {
+		final long timeout = (System.currentTimeMillis() + duration);
+
+		try {
+			while (!condition.evaluate() && System.currentTimeMillis() < timeout) {
+				synchronized (condition) {
+					TimeUnit.MILLISECONDS.timedWait(condition, DEFAULT_WAIT_INTERVAL);
+				}
+			}
+		}
+		catch (InterruptedException e) {
+			Thread.currentThread().interrupt();
+		}
+
+		return condition.evaluate();
+	}
+}

samples/httpsession-gemfire-clientserver/src/main/java/sample/Initializer.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2002-2015 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 sample;
+
+import org.springframework.session.web.context.AbstractHttpSessionApplicationInitializer;
+
+// tag::class[]
+public class Initializer
+		extends AbstractHttpSessionApplicationInitializer { // <1>
+
+	public Initializer() {
+		super(ClientConfig.class); // <2>
+	}
+}
+// end::class[]

samples/httpsession-gemfire-clientserver/src/main/java/sample/ServerConfig.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2002-2015 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 sample;
+
+import java.io.IOException;
+import java.util.Properties;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
+import org.springframework.data.gemfire.CacheFactoryBean;
+import org.springframework.data.gemfire.server.CacheServerFactoryBean;
+import org.springframework.session.data.gemfire.config.annotation.web.http.EnableGemFireHttpSession;
+
+import com.gemstone.gemfire.cache.Cache;
+
+// tag::class[]
+@EnableGemFireHttpSession(maxInactiveIntervalInSeconds = 30)// <1>
+public class ServerConfig {
+
+	static final int MAX_CONNECTIONS = 50;
+	static final int SERVER_PORT = 12480;
+
+	static final String SERVER_HOSTNAME = "localhost";
+
+	@Bean
+	PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
+		return new PropertySourcesPlaceholderConfigurer();
+	}
+
+	@Bean
+	Properties gemfireProperties() { // <2>
+		Properties gemfireProperties = new Properties();
+
+		gemfireProperties.setProperty("name", "GemFireClientServerHttpSessionSample");
+		gemfireProperties.setProperty("mcast-port", "0");
+		gemfireProperties.setProperty("log-level",
+			System.getProperty("sample.httpsession.gemfire.log-level", "warning"));
+		gemfireProperties.setProperty("jmx-manager", "true");
+		gemfireProperties.setProperty("jmx-manager-start", "true");
+
+		return gemfireProperties;
+	}
+
+	@Bean
+	CacheFactoryBean gemfireCache() { // <3>
+		CacheFactoryBean gemfireCache = new CacheFactoryBean();
+
+		gemfireCache.setProperties(gemfireProperties());
+		gemfireCache.setUseBeanFactoryLocator(false);
+
+		return gemfireCache;
+	}
+
+	@Bean
+	CacheServerFactoryBean gemfireCacheServer(Cache gemfireCache, // <4>
+		    @Value("${spring.session.data.gemfire.port:"+SERVER_PORT+"}") int port) {
+
+		CacheServerFactoryBean cacheServerFactory = new CacheServerFactoryBean();
+
+		cacheServerFactory.setAutoStartup(true);
+		cacheServerFactory.setBindAddress(SERVER_HOSTNAME);
+		cacheServerFactory.setCache(gemfireCache);
+		cacheServerFactory.setMaxConnections(MAX_CONNECTIONS);
+		cacheServerFactory.setPort(port);
+
+		return cacheServerFactory;
+	}
+
+	public static void main(final String[] args) throws IOException { // <5>
+		new AnnotationConfigApplicationContext(ServerConfig.class)
+			.registerShutdownHook();
+	}
+}
+// end::class[]

samples/httpsession-gemfire-clientserver/src/main/java/sample/SessionServlet.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2002-2015 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 sample;
+
+import java.io.IOException;
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+// tag::class[]
+@WebServlet("/session")
+public class SessionServlet extends HttpServlet {
+
+	@Override
+	protected void doPost(HttpServletRequest request, HttpServletResponse response)
+			throws ServletException, IOException {
+		String attributeName = request.getParameter("attributeName");
+		String attributeValue = request.getParameter("attributeValue");
+		request.getSession().setAttribute(attributeName, attributeValue);
+		response.sendRedirect(request.getContextPath() + "/");
+	}
+
+	private static final long serialVersionUID = 2878267318695777395L;
+}
+// tag::end[]

samples/httpsession-gemfire-clientserver/src/main/webapp/index.jsp

@@ -0,0 +1,48 @@
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<title>Session Attributes</title>
+	<link rel="stylesheet" href="assets/bootstrap.min.css">
+	<style type="text/css">
+		body {
+			padding: 1em;
+		}
+	</style>
+</head>
+<body>
+	<div class="container">
+		<h1>Description</h1>
+		<p>This application demonstrates how to use a GemFire instance to back your session. Notice that there is no JSESSIONID cookie. We are also able to customize the way of identifying what the requested session id is.</p>
+
+		<h1>Try it</h1>
+
+		<form class="form-inline" role="form" action="./session" method="post">
+			<label for="attributeName">Attribute Name</label>
+			<input id="attributeName" type="text" name="attributeName"/>
+			<label for="attributeValue">Attribute Value</label>
+			<input id="attributeValue" type="text" name="attributeValue"/>
+			<input type="submit" value="Set Attribute"/>
+		</form>
+
+		<hr/>
+
+		<table class="table table-striped">
+			<thead>
+			<tr>
+				<th>Attribute Name</th>
+				<th>Attribute Value</th>
+			</tr>
+			</thead>
+			<tbody>
+			<c:forEach items="${sessionScope}" var="attr">
+				<tr>
+					<td><c:out value="${attr.key}"/></td>
+					<td><c:out value="${attr.value}"/></td>
+				</tr>
+			</c:forEach>
+			</tbody>
+		</table>
+	</div>
+</body>
+</html>