Restructure samples

samples/java/java-gemfire-clientserver/build.gradle

@@ -0,0 +1,70 @@
+apply from: JAVA_GRADLE
+apply from: TOMCAT_7_GRADLE
+apply plugin: "application"
+apply from: SAMPLE_GRADLE
+
+dependencies {
+	compile project(':spring-session-data-gemfire'),
+		"org.springframework:spring-web:$springVersion",
+		"org.webjars:bootstrap:$bootstrapVersion",
+		"org.webjars:webjars-taglib:$webjarsTaglibVersion",
+		jstlDependencies
+
+	providedCompile "javax.servlet:javax.servlet-api:$servletApiVersion"
+
+	runtime "org.springframework.shell:spring-shell:1.0.0.RELEASE"
+
+	testCompile "junit:junit:$junitVersion",
+			"org.assertj:assertj-core:$assertjVersion"
+
+	integrationTestCompile seleniumDependencies
+
+	integrationTestRuntime "org.springframework.shell:spring-shell:1.0.0.RELEASE"
+}
+
+
+def port
+def process
+
+mainClassName = "sample.ServerConfig"
+
+task availablePort() {
+	doLast {
+		def serverSocket = new ServerSocket(0)
+		port = serverSocket.localPort
+		serverSocket.close()
+	}
+}
+
+task runGemFireServer(dependsOn: availablePort) {
+	doLast {
+		println 'STARTING GEMFIRE SERVER...'
+
+		String classpath = sourceSets.main.runtimeClasspath.collect { it }.join(File.pathSeparator)
+
+		String[] commandLine = ['java', '-server', '-ea',
+				"-Dspring.session.data.gemfire.port=$port",
+				"-Dsample.httpsession.gemfire.log-level="
+						+ System.getProperty('sample.httpsession.gemfire.log-level', 'warning'),
+				'-classpath', classpath, 'sample.ServerConfig']
+
+		//println commandLine
+
+		process = commandLine.execute()
+		process.in.close()
+		process.out.close()
+		process.err.close()
+	}
+}
+
+integrationTest.doLast {
+	println 'STOPPING GEMFIRE SERVER...'
+	process?.destroyForcibly()
+}
+
+integrationTomcatRun {
+	dependsOn runGemFireServer
+	doFirst {
+		System.setProperty("spring.session.data.gemfire.port", "$port");
+	}
+}

samples/java/java-gemfire-clientserver/src/integration-test/java/sample/AttributeTests.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2014-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 sample;
+
+import java.util.List;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.htmlunit.HtmlUnitDriver;
+import sample.pages.HomePage;
+import sample.pages.HomePage.Attribute;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Eddú Meléndez
+ * @author Rob Winch
+ */
+public class AttributeTests {
+
+	private WebDriver driver;
+
+	@Before
+	public void setup() {
+		this.driver = new HtmlUnitDriver();
+	}
+
+	@After
+	public void tearDown() {
+		this.driver.quit();
+	}
+
+	@Test
+	public void home() {
+		HomePage home = HomePage.go(this.driver);
+		home.assertAt();
+	}
+
+	@Test
+	public void noAttributes() {
+		HomePage home = HomePage.go(this.driver);
+		assertThat(home.attributes()).isEmpty();
+	}
+
+	@Test
+	public void createAttribute() {
+		HomePage home = HomePage.go(this.driver);
+		// @formatter:off
+		home = home.form()
+				.attributeName("a")
+				.attributeValue("b")
+				.submit(HomePage.class);
+		// @formatter:on
+
+		List<Attribute> attributes = home.attributes();
+		assertThat(attributes).hasSize(1);
+		Attribute row = attributes.get(0);
+		assertThat(row.getAttributeName()).isEqualTo("a");
+		assertThat(row.getAttributeValue()).isEqualTo("b");
+	}
+
+}

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

@@ -0,0 +1,135 @@
+/*
+ * Copyright 2014-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 sample.pages;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.openqa.selenium.SearchContext;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.support.FindBy;
+import org.openqa.selenium.support.PageFactory;
+import org.openqa.selenium.support.pagefactory.DefaultElementLocatorFactory;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Eddú Meléndez
+ * @author Rob Winch
+ */
+public class HomePage {
+
+	private WebDriver driver;
+
+	@FindBy(css = "form")
+	WebElement form;
+
+	@FindBy(css = "table tbody tr")
+	List<WebElement> trs;
+
+	List<Attribute> attributes;
+
+	public HomePage(WebDriver driver) {
+		this.driver = driver;
+		this.attributes = new ArrayList<Attribute>();
+	}
+
+	private static void get(WebDriver driver, String get) {
+		String baseUrl = "http://localhost:" + System.getProperty("tomcat.port", "8080");
+		driver.get(baseUrl + get);
+	}
+
+	public static HomePage go(WebDriver driver) {
+		get(driver, "/");
+		return PageFactory.initElements(driver, HomePage.class);
+	}
+
+	public void assertAt() {
+		assertThat(this.driver.getTitle()).isEqualTo("Session Attributes");
+	}
+
+	public List<Attribute> attributes() {
+		List<Attribute> rows = new ArrayList<Attribute>();
+		for (WebElement tr : this.trs) {
+			rows.add(new Attribute(tr));
+		}
+		this.attributes.addAll(rows);
+		return this.attributes;
+	}
+
+	public Form form() {
+		return new Form(this.form);
+	}
+
+	public class Form {
+		@FindBy(name = "attributeName")
+		WebElement attributeName;
+
+		@FindBy(name = "attributeValue")
+		WebElement attributeValue;
+
+		@FindBy(css = "input[type=\"submit\"]")
+		WebElement submit;
+
+		public Form(SearchContext context) {
+			PageFactory.initElements(new DefaultElementLocatorFactory(context), this);
+		}
+
+		public Form attributeName(String text) {
+			this.attributeName.sendKeys(text);
+			return this;
+		}
+
+		public Form attributeValue(String text) {
+			this.attributeValue.sendKeys(text);
+			return this;
+		}
+
+		public <T> T submit(Class<T> page) {
+			this.submit.click();
+			return PageFactory.initElements(HomePage.this.driver, page);
+		}
+	}
+
+	public static class Attribute {
+		@FindBy(xpath = ".//td[1]")
+		WebElement attributeName;
+
+		@FindBy(xpath = ".//td[2]")
+		WebElement attributeValue;
+
+		public Attribute(SearchContext context) {
+			PageFactory.initElements(new DefaultElementLocatorFactory(context), this);
+		}
+
+		/**
+		 * @return the attributeName
+		 */
+		public String getAttributeName() {
+			return this.attributeName.getText();
+		}
+
+		/**
+		 * @return the attributeValue
+		 */
+		public String getAttributeValue() {
+			return this.attributeValue.getText();
+		}
+	}
+
+}

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

@@ -0,0 +1,137 @@
+/*
+ * 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 sample;
+
+import java.util.Collections;
+import java.util.Properties;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+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;
+
+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.support.ConnectionEndpoint;
+import org.springframework.session.data.gemfire.config.annotation.web.http.EnableGemFireHttpSession;
+import org.springframework.util.Assert;
+
+// tag::class[]
+@EnableGemFireHttpSession(maxInactiveIntervalInSeconds = 30, poolName = "DEFAULT") // <1>
+public class ClientConfig {
+
+	static final long DEFAULT_WAIT_DURATION = TimeUnit.SECONDS.toMillis(20);
+
+	static final CountDownLatch latch = new CountDownLatch(1);
+
+	static final String DEFAULT_GEMFIRE_LOG_LEVEL = "warning";
+
+	@Bean
+	static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
+		return new PropertySourcesPlaceholderConfigurer();
+	}
+
+	Properties gemfireProperties() { // <2>
+		Properties gemfireProperties = new Properties();
+		gemfireProperties.setProperty("name", applicationName());
+		gemfireProperties.setProperty("log-level", logLevel());
+		return gemfireProperties;
+	}
+
+	String applicationName() {
+		return "samples:httpsession-gemfire-clientserver:"
+			.concat(getClass().getSimpleName());
+	}
+
+	String logLevel() {
+		return System.getProperty("sample.httpsession.gemfire.log-level",
+			DEFAULT_GEMFIRE_LOG_LEVEL);
+	}
+
+	@Bean
+	ClientCacheFactoryBean gemfireCache(
+			@Value("${spring.session.data.gemfire.port:" + ServerConfig.SERVER_PORT + "}") int port) { // <3>
+
+		ClientCacheFactoryBean clientCacheFactory = new ClientCacheFactoryBean();
+
+		clientCacheFactory.setClose(true);
+		clientCacheFactory.setProperties(gemfireProperties());
+
+		// GemFire Pool settings <4>
+		clientCacheFactory.setKeepAlive(false);
+		clientCacheFactory.setPingInterval(TimeUnit.SECONDS.toMillis(5));
+		clientCacheFactory.setReadTimeout(2000); // 2 seconds
+		clientCacheFactory.setRetryAttempts(1);
+		clientCacheFactory.setSubscriptionEnabled(true);
+		clientCacheFactory.setThreadLocalConnections(false);
+
+		clientCacheFactory.setServers(Collections.singletonList(
+			newConnectionEndpoint(ServerConfig.SERVER_HOST, port)));
+
+		return clientCacheFactory;
+	}
+
+	ConnectionEndpoint newConnectionEndpoint(String host, int port) {
+		return new ConnectionEndpoint(host, port);
+	}
+
+	@Bean
+	BeanPostProcessor gemfireCacheServerReadyBeanPostProcessor() { // <5>
+		return new BeanPostProcessor() {
+
+			public Object postProcessBeforeInitialization(Object bean, String beanName)
+				throws BeansException {
+
+				if ("gemfirePool".equals(beanName)) {
+					ClientMembership.registerClientMembershipListener(
+						new ClientMembershipListenerAdapter() {
+							@Override
+							public void memberJoined(ClientMembershipEvent event) {
+								latch.countDown();
+							}
+						});
+				}
+
+				return bean;
+			}
+
+			public Object postProcessAfterInitialization(Object bean, String beanName)
+				throws BeansException {
+
+				if (bean instanceof Pool && "gemfirePool".equals(beanName)) {
+					try {
+						Assert.state(latch.await(DEFAULT_WAIT_DURATION, TimeUnit.MILLISECONDS),
+							String.format("GemFire Cache Server failed to start on host [%1$s] and port [%2$d]",
+								ServerConfig.SERVER_HOST, ServerConfig.SERVER_PORT));
+					}
+					catch (InterruptedException e) {
+						Thread.currentThread().interrupt();
+					}
+				}
+
+				return bean;
+			}
+		};
+	}
+	// end::class[]
+}

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

@@ -0,0 +1,28 @@
+/*
+ * 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 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/java/java-gemfire-clientserver/src/main/java/sample/ServerConfig.java

@@ -0,0 +1,101 @@
+/*
+ * 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 sample;
+
+import java.io.IOException;
+import java.util.Properties;
+import java.util.concurrent.TimeUnit;
+
+import com.gemstone.gemfire.cache.Cache;
+
+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;
+
+// tag::class[]
+@EnableGemFireHttpSession(maxInactiveIntervalInSeconds = 30) // <1>
+public class ServerConfig {
+
+	static final int SERVER_PORT = 12480;
+
+	static final String DEFAULT_GEMFIRE_LOG_LEVEL = "warning";
+	static final String SERVER_HOST = "localhost";
+
+	@SuppressWarnings("resource")
+	public static void main(String[] args) throws IOException { // <5>
+		new AnnotationConfigApplicationContext(ServerConfig.class)
+			.registerShutdownHook();
+	}
+
+	@Bean
+	static PropertySourcesPlaceholderConfigurer propertyPlaceholderConfigurer() {
+		return new PropertySourcesPlaceholderConfigurer();
+	}
+
+	Properties gemfireProperties() { // <2>
+		Properties gemfireProperties = new Properties();
+
+		gemfireProperties.setProperty("name", applicationName());
+		gemfireProperties.setProperty("mcast-port", "0");
+		gemfireProperties.setProperty("log-level", logLevel());
+		gemfireProperties.setProperty("jmx-manager", "true");
+		gemfireProperties.setProperty("jmx-manager-start", "true");
+
+		return gemfireProperties;
+	}
+
+	String applicationName() {
+		return "samples:httpsession-gemfire-clientserver:"
+			.concat(getClass().getSimpleName());
+	}
+
+	String logLevel() {
+		return System.getProperty("sample.httpsession.gemfire.log-level",
+			DEFAULT_GEMFIRE_LOG_LEVEL);
+	}
+
+	@Bean
+	CacheFactoryBean gemfireCache() { // <3>
+		CacheFactoryBean gemfireCache = new CacheFactoryBean();
+
+		gemfireCache.setClose(true);
+		gemfireCache.setProperties(gemfireProperties());
+
+		return gemfireCache;
+	}
+
+	@Bean
+	CacheServerFactoryBean gemfireCacheServer(Cache gemfireCache,
+			@Value("${spring.session.data.gemfire.port:" + SERVER_PORT + "}") int port) { // <4>
+
+		CacheServerFactoryBean gemfireCacheServer = new CacheServerFactoryBean();
+
+		gemfireCacheServer.setAutoStartup(true);
+		gemfireCacheServer.setBindAddress(SERVER_HOST);
+		gemfireCacheServer.setCache(gemfireCache);
+		gemfireCacheServer.setHostNameForClients(SERVER_HOST);
+		gemfireCacheServer.setMaxTimeBetweenPings(Long.valueOf(TimeUnit.SECONDS.toMillis(60)).intValue());
+		gemfireCacheServer.setPort(port);
+
+		return gemfireCacheServer;
+	}
+}
+// end::class[]

samples/java/java-gemfire-clientserver/src/main/java/sample/SessionServlet.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 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/java/java-gemfire-clientserver/src/main/webapp/index.jsp

@@ -0,0 +1,50 @@
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<%@ taglib prefix="wj" uri="http://www.webjars.org/tags" %>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<title>Session Attributes</title>
+	<wj:locate path="bootstrap.min.css" relativeTo="META-INF/resources" var="bootstrapCssLocation"/>
+	<link rel="stylesheet" href="<c:url value="${bootstrapCssLocation}"/>">
+	<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>