Polish

Author: rstoyanchev

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

@@ -60,7 +60,7 @@ class DefaultWebSession implements WebSession {
 
 
 	/**
-	 * Constructor for creating a brand, new session.
+	 * Constructor for creating a new session instance.
 	 * @param idGenerator the session id generator
 	 * @param clock for access to current time
 	 */
@@ -86,7 +86,8 @@ class DefaultWebSession implements WebSession {
 	}
 
 	/**
-	 * Constructor for creating a new session with an updated last access time.
+	 * Copy constructor to re-create a session at the start of a new request
+	 * refreshing the last access time of the session.
 	 * @param existingSession the existing session to copy
 	 * @param lastAccessTime the new last access time
 	 */

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

@@ -40,6 +40,7 @@ public class DefaultWebSessionManager implements WebSessionManager {
 
 	private WebSessionStore sessionStore = new InMemoryWebSessionStore();
 
+
 	/**
 	 * Configure the id resolution strategy.
 	 * <p>By default an instance of {@link CookieWebSessionIdResolver}.
@@ -74,6 +75,7 @@ public WebSessionStore getSessionStore() {
 		return this.sessionStore;
 	}
 
+
 	@Override
 	public Mono<WebSession> getSession(ServerWebExchange exchange) {
 		return Mono.defer(() ->

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

@@ -31,13 +31,13 @@
  */
 public class HeaderWebSessionIdResolver implements WebSessionIdResolver {
 
-	/**
-	 * The default header name
-	 */
+	/** 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
@@ -50,6 +50,15 @@ public void setHeaderName(String headerName) {
 		this.headerName = headerName;
 	}
 
+	/**
+	 * Return the configured header name.
+	 * @return the configured header name
+	 */
+	public String getHeaderName() {
+		return this.headerName;
+	}
+
+
 	@Override
 	public List<String> resolveSessionIds(ServerWebExchange exchange) {
 		HttpHeaders headers = exchange.getRequest().getHeaders();
@@ -67,11 +76,4 @@ public void expireSession(ServerWebExchange exchange) {
 		this.setSessionId(exchange, "");
 	}
 
-	/**
-	 * Return the configured header name.
-	 * @return the configured header name
-	 */
-	private String getHeaderName() {
-		return this.headerName;
-	}
 }

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

@@ -39,11 +39,34 @@ public class InMemoryWebSessionStore implements WebSessionStore {
 
 	private static final IdGenerator idGenerator = new JdkIdGenerator();
 
+
 	private Clock clock = Clock.system(ZoneId.of("GMT"));
 
 	private final Map<String, WebSession> sessions = new ConcurrentHashMap<>();
 
 
+	/**
+	 * 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> retrieveSession(String id) {
 		return (this.sessions.containsKey(id) ? Mono.just(this.sessions.get(id)) : Mono.empty());
@@ -70,27 +93,6 @@ public Mono<WebSession> updateLastAccessTime(WebSession webSession) {
 		});
 	}
 
-	/**
-	 * 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;
-	}
-
 	private Mono<Void> changeSessionId(String oldId, WebSession session) {
 		this.sessions.remove(oldId);
 		this.sessions.put(session.getId(), session);

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

@@ -19,8 +19,6 @@
 
 import org.springframework.web.server.WebSession;
 
-import java.time.Instant;
-
 /**
  * Strategy for {@link WebSession} persistence.
  *
@@ -31,8 +29,12 @@
 public interface WebSessionStore {
 
 	/**
-	 * Creates the WebSession that can be stored by this WebSessionStore.
-	 * @return the session
+	 * Create a new WebSession.
+	 * <p>Note that this does nothing more than create a new instance.
+	 * The session can later be started explicitly via {@link WebSession#start()}
+	 * or implicitly by adding attributes -- and then persisted via
+	 * {@link WebSession#save()}.
+	 * @return the created session instance
 	 */
 	Mono<WebSession> createWebSession();
 
@@ -51,7 +53,7 @@ public interface WebSessionStore {
 	Mono<Void> removeSession(String sessionId);
 
 	/**
-	 * Update the last accessed time to now.
+	 * Update the last accessed timestamp to "now".
 	 * @param webSession the session to update
 	 * @return the session with the updated last access time
 	 */