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-xml/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-xml/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-xml/src/main/java/sample/Application.java

@@ -0,0 +1,31 @@
+/*
+ * 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.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.ImportResource;
+
+// tag::class[]
+@Configuration // <1>
+@ImportResource("META-INF/spring/session-server.xml") // <2>
+public class Application {
+
+	public static void main(final String[] args) {
+		new AnnotationConfigApplicationContext(Application.class).registerShutdownHook();
+	}
+}
+// tag::end[]

samples/httpsession-gemfire-clientserver-xml/src/main/java/sample/GemFireCacheServerReadyBeanPostProcessor.java

@@ -0,0 +1,151 @@
+/*
+ * 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.Properties;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+import javax.annotation.Resource;
+
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.data.gemfire.client.PoolFactoryBean;
+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;
+
+public class GemFireCacheServerReadyBeanPostProcessor implements BeanPostProcessor {
+
+	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 final String DEFAULT_SERVER_HOST = "localhost";
+
+	@Value("${spring.session.data.gemfire.port:${application.gemfire.client-server.port}}")
+	int port;
+
+// tag::class[]
+	static {
+		ClientMembership.registerClientMembershipListener(new ClientMembershipListenerAdapter() {
+			public void memberJoined(final ClientMembershipEvent event) {
+				if (!event.isClient()) {
+					latch.countDown();
+				}
+			}
+		});
+	}
+
+	@SuppressWarnings("all")
+	@Resource(name = "applicationProperties")
+	private Properties applicationProperties;
+
+	public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
+		if (bean instanceof PoolFactoryBean || bean instanceof Pool) {
+			String host = getServerHost(DEFAULT_SERVER_HOST);
+			Assert.isTrue(waitForCacheServerToStart(host, port), String.format(
+				"GemFire Server failed to start [host: '%1$s', port: %2$d]%n", host, 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;
+	}
+// tag::end[]
+
+	interface Condition {
+		boolean evaluate();
+	}
+
+	String getServerHost(String defaultServerHost) {
+		return applicationProperties.getProperty("application.gemfire.client-server.host", defaultServerHost);
+	}
+
+	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-xml/src/main/java/sample/SessionServlet.java

@@ -0,0 +1,38 @@
+/*
+ * 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.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+// tag::class[]
+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-xml/src/main/resources/META-INF/spring/application.properties

@@ -0,0 +1,3 @@
+application.gemfire.client-server.host=localhost
+application.gemfire.client-server.port=11235
+application.gemfire.client-server.max-connections=50

samples/httpsession-gemfire-clientserver-xml/src/main/resources/META-INF/spring/session-server.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+	   xmlns:context="http://www.springframework.org/schema/context"
+	   xmlns:gfe="http://www.springframework.org/schema/gemfire"
+	   xmlns:p="http://www.springframework.org/schema/p"
+	   xmlns:util="http://www.springframework.org/schema/util"
+	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	   xsi:schemaLocation="
+	   	http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
+        http://www.springframework.org/schema/gemfire http://www.springframework.org/schema/gemfire/spring-gemfire.xsd
+		http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd
+">
+
+	<!-- tag::beans[] -->
+	<!--1-->
+	<context:annotation-config/>
+
+	<!--2-->
+	<context:property-placeholder location="classpath:META-INF/spring/application.properties"/>
+
+	<!--3-->
+	<bean class="org.springframework.session.data.gemfire.config.annotation.web.http.GemFireHttpSessionConfiguration"
+          p:maxInactiveIntervalInSeconds="30"/>
+
+	<!--4-->
+	<util:properties id="gemfireProperties">
+		<prop key="name">GemFireClientServerHttpSessionXmlSample</prop>
+		<prop key="mcast-port">0</prop>
+		<prop key="log-level">${sample.httpsession.gemfire.log-level:warning}</prop>
+		<prop key="jmx-manager">true</prop>
+		<prop key="jmx-manager-start">true</prop>
+	</util:properties>
+
+	<!--5-->
+	<gfe:cache properties-ref="gemfireProperties"
+               use-bean-factory-locator="false"/>
+
+	<!--6-->
+	<gfe:cache-server auto-startup="true"
+                      bind-address="${application.gemfire.client-server.host}"
+                      port="${spring.session.data.gemfire.port:${application.gemfire.client-server.port}}"
+                      max-connections="${application.gemfire.client-server.max-connections}"/>
+	<!-- end::beans[] -->
+
+</beans>

samples/httpsession-gemfire-clientserver-xml/src/main/webapp/WEB-INF/spring/session-client.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+	   xmlns:context="http://www.springframework.org/schema/context"
+	   xmlns:gfe="http://www.springframework.org/schema/gemfire"
+	   xmlns:p="http://www.springframework.org/schema/p"
+	   xmlns:util="http://www.springframework.org/schema/util"
+	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	   xsi:schemaLocation="
+	   	http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
+        http://www.springframework.org/schema/gemfire http://www.springframework.org/schema/gemfire/spring-gemfire.xsd
+		http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd
+">
+
+	<!-- tag::beans[] -->
+	<!--1-->
+	<util:properties id="applicationProperties"
+                     location="classpath:META-INF/spring/application.properties"/>
+
+	<!--2-->
+	<context:property-placeholder properties-ref="applicationProperties"/>
+
+	<!--3-->
+	<context:annotation-config/>
+
+	<!--4-->
+	<bean class="org.springframework.session.data.gemfire.config.annotation.web.http.GemFireHttpSessionConfiguration"
+          p:maxInactiveIntervalInSeconds="30"/>
+
+	<!--5-->
+	<bean class="sample.GemFireCacheServerReadyBeanPostProcessor"/>
+
+	<!--6-->
+	<util:properties id="gemfireProperties">
+		<prop key="log-level">${sample.httpsession.gemfire.log-level:warning}</prop>
+	</util:properties>
+
+	<!--7-->
+	<gfe:pool free-connection-timeout="5000"
+              keep-alive="false"
+              ping-interval="5000"
+              read-timeout="5000"
+              retry-attempts="2"
+              subscription-enabled="true"
+              thread-local-connections="false"
+              max-connections="${application.gemfire.client-server.max-connections}">
+		<gfe:server host="${application.gemfire.client-server.host}"
+                    port="${spring.session.data.gemfire.port:${application.gemfire.client-server.port}}"/>
+	</gfe:pool>
+
+	<gfe:client-cache properties-ref="gemfireProperties"
+                      use-bean-factory-locator="false"/>
+	<!-- end::beans[] -->
+
+</beans>

samples/httpsession-gemfire-clientserver-xml/src/main/webapp/WEB-INF/web.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
+		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
+	<!--
+	- Location of the XML file that defines the root application context
+	- Applied by ContextLoaderListener.
+	-->
+	<!-- tag::context-param[] -->
+	<context-param>
+		<param-name>contextConfigLocation</param-name>
+		<param-value>
+			/WEB-INF/spring/session-client.xml
+		</param-value>
+	</context-param>
+	<!-- end::context-param[] -->
+
+	<!-- tag::springSessionRepositoryFilter[] -->
+	<filter>
+		<filter-name>springSessionRepositoryFilter</filter-name>
+		<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
+	</filter>
+	<filter-mapping>
+		<filter-name>springSessionRepositoryFilter</filter-name>
+		<url-pattern>/*</url-pattern>
+	</filter-mapping>
+	<!-- end::springSessionRepositoryFilter[] -->
+
+	<!--
+	- Loads the root application context of this web app at startup.
+	- The application context is then available via
+	- WebApplicationContextUtils.getWebApplicationContext(servletContext).
+	-->
+	<!-- tag::listeners[] -->
+	<listener>
+		<listener-class>
+			org.springframework.web.context.ContextLoaderListener
+		</listener-class>
+	</listener>
+	<!-- end::listeners[] -->
+
+	<servlet>
+		<servlet-name>session</servlet-name>
+		<servlet-class>sample.SessionServlet</servlet-class>
+	</servlet>
+
+	<servlet-mapping>
+		<servlet-name>session</servlet-name>
+		<url-pattern>/session</url-pattern>
+	</servlet-mapping>
+
+	<welcome-file-list>
+		<welcome-file>index.jsp</welcome-file>
+	</welcome-file-list>
+</web-app>

samples/httpsession-gemfire-clientserver-xml/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>