Merge pull request #1507 from rwinch/websessionmanager

Author: rstoyanchev

spring-web/src/main/java/org/springframework/web/server/session/DefaultWebSession.java

@@ -15,17 +15,12 @@
  */
 package org.springframework.web.server.session;
 
-import java.time.Clock;
-import java.time.Instant;
-import java.time.ZoneId;
 import java.util.List;
 
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
 import org.springframework.util.Assert;
-import org.springframework.util.IdGenerator;
-import org.springframework.util.JdkIdGenerator;
 import org.springframework.web.server.ServerWebExchange;
 import org.springframework.web.server.WebSession;
 
@@ -36,19 +31,15 @@
  * {@link WebSessionStore}
  *
  * @author Rossen Stoyanchev
+ * @author Rob Winch
  * @since 5.0
  */
 public class DefaultWebSessionManager implements WebSessionManager {
 
-	private static final IdGenerator idGenerator = new JdkIdGenerator();
-
-
 	private WebSessionIdResolver sessionIdResolver = new CookieWebSessionIdResolver();
 
 	private WebSessionStore sessionStore = new InMemoryWebSessionStore();
 
-	private Clock clock = Clock.system(ZoneId.of("GMT"));
-
 
 	/**
 	 * Configure the id resolution strategy.
@@ -84,89 +75,53 @@ public WebSessionStore getSessionStore() {
 		return this.sessionStore;
 	}
 
-	/**
-	 * Configure the {@link Clock} to use to set lastAccessTime on every created
-	 * session and to calculate if it is expired.
-	 * <p>This may be useful to align to different timezone or to set the clock
-	 * back in a test, e.g. {@code Clock.offset(clock, Duration.ofMinutes(-31))}
-	 * in order to simulate session expiration.
-	 * <p>By default this is {@code Clock.system(ZoneId.of("GMT"))}.
-	 * @param clock the clock to use
-	 */
-	public void setClock(Clock clock) {
-		Assert.notNull(clock, "'clock' is required.");
-		this.clock = clock;
-	}
-
-	/**
-	 * Return the configured clock for session lastAccessTime calculations.
-	 */
-	public Clock getClock() {
-		return this.clock;
-	}
-
 
 	@Override
 	public Mono<WebSession> getSession(ServerWebExchange exchange) {
 		return Mono.defer(() ->
 				retrieveSession(exchange)
 						.flatMap(session -> removeSessionIfExpired(exchange, session))
-						.map(session -> {
-							Instant lastAccessTime = Instant.now(getClock());
-							return new DefaultWebSession(session, lastAccessTime, s -> saveSession(exchange, s));
-						})
-						.switchIfEmpty(createSession(exchange))
-						.doOnNext(session -> exchange.getResponse().beforeCommit(session::save)));
+						.flatMap(this.getSessionStore()::updateLastAccessTime)
+						.switchIfEmpty(this.sessionStore.createWebSession())
+						.doOnNext(session -> exchange.getResponse().beforeCommit(() -> save(exchange, session))));
 	}
 
-	private Mono<DefaultWebSession> retrieveSession(ServerWebExchange exchange) {
+	private Mono<WebSession> retrieveSession(ServerWebExchange exchange) {
 		return Flux.fromIterable(getSessionIdResolver().resolveSessionIds(exchange))
 				.concatMap(this.sessionStore::retrieveSession)
-				.cast(DefaultWebSession.class)
 				.next();
 	}
 
-	private Mono<DefaultWebSession> removeSessionIfExpired(ServerWebExchange exchange, DefaultWebSession session) {
+	private Mono<WebSession> removeSessionIfExpired(ServerWebExchange exchange, WebSession session) {
 		if (session.isExpired()) {
 			this.sessionIdResolver.expireSession(exchange);
 			return this.sessionStore.removeSession(session.getId()).then(Mono.empty());
 		}
 		return Mono.just(session);
 	}
 
-	private Mono<Void> saveSession(ServerWebExchange exchange, WebSession session) {
+	private Mono<Void> save(ServerWebExchange exchange, WebSession session) {
 		if (session.isExpired()) {
 			return Mono.error(new IllegalStateException(
 					"Sessions are checked for expiration and have their " +
-					"lastAccessTime updated when first accessed during request processing. " +
-					"However this session is expired meaning that maxIdleTime elapsed " +
-					"before the call to session.save()."));
+							"lastAccessTime updated when first accessed during request processing. " +
+							"However this session is expired meaning that maxIdleTime elapsed " +
+							"before the call to session.save()."));
 		}
 
 		if (!session.isStarted()) {
 			return Mono.empty();
 		}
 
-		// Force explicit start
-		session.start();
-
 		if (hasNewSessionId(exchange, session)) {
-			this.sessionIdResolver.setSessionId(exchange, session.getId());
+			DefaultWebSessionManager.this.sessionIdResolver.setSessionId(exchange, session.getId());
 		}
 
- 		return this.sessionStore.storeSession(session);
+		return session.save();
 	}
 
 	private boolean hasNewSessionId(ServerWebExchange exchange, WebSession session) {
 		List<String> ids = getSessionIdResolver().resolveSessionIds(exchange);
 		return ids.isEmpty() || !session.getId().equals(ids.get(0));
 	}
-
-	private Mono<DefaultWebSession> createSession(ServerWebExchange exchange) {
-		return Mono.fromSupplier(() ->
-				new DefaultWebSession(idGenerator, getClock(),
-						(oldId, session) -> this.sessionStore.changeSessionId(oldId, session),
-						session -> saveSession(exchange, session)));
-	}
-
 }

spring-web/src/main/java/org/springframework/web/server/session/DefaultWebSessionManager.java

@@ -26,18 +26,23 @@
  * Request and response header-based {@link WebSessionIdResolver}.
  * 
  * @author Greg Turnquist
+ * @author Rob Winch
  * @since 5.0
  */
 public class HeaderWebSessionIdResolver implements WebSessionIdResolver {
 
-	private String headerName = "SESSION";
+	/** Default value for {@link #setHeaderName(String)}. */
+	public static final String DEFAULT_HEADER_NAME = "SESSION";
+
+
+	private String headerName = DEFAULT_HEADER_NAME;
 
 
 	/**
 	 * Set the name of the session header to use for the session id.
 	 * The name is used to extract the session id from the request headers as
 	 * well to set the session id on the response headers.
-	 * <p>By default set to {@literal "SESSION"}.
+	 * <p>By default set to {@code DEFAULT_HEADER_NAME}
 	 * @param headerName the header name
 	 */
 	public void setHeaderName(String headerName) {
@@ -47,6 +52,7 @@ public void setHeaderName(String headerName) {
 
 	/**
 	 * Return the configured header name.
+	 * @return the configured header name
 	 */
 	public String getHeaderName() {
 		return this.headerName;