diff --git a/spring-session/src/main/java/org/springframework/session/MapSessionRepository.java b/spring-session/src/main/java/org/springframework/session/MapSessionRepository.java index a16bf563..820664bc 100644 --- a/spring-session/src/main/java/org/springframework/session/MapSessionRepository.java +++ b/spring-session/src/main/java/org/springframework/session/MapSessionRepository.java @@ -61,7 +61,7 @@ public class MapSessionRepository implements SessionRepository /** * If non-null, this value is used to override {@link ExpiringSession#setMaxInactiveInterval(int)}. - * @param defaultMaxInactiveInterval + * @param defaultMaxInactiveInterval the number of seconds that the {@link Session} should be kept alive between client requests. */ public void setDefaultMaxInactiveInterval(int defaultMaxInactiveInterval) { this.defaultMaxInactiveInterval = Integer.valueOf(defaultMaxInactiveInterval); diff --git a/spring-session/src/main/java/org/springframework/session/data/redis/RedisOperationsSessionRepository.java b/spring-session/src/main/java/org/springframework/session/data/redis/RedisOperationsSessionRepository.java index 6744bc90..520e6760 100644 --- a/spring-session/src/main/java/org/springframework/session/data/redis/RedisOperationsSessionRepository.java +++ b/spring-session/src/main/java/org/springframework/session/data/redis/RedisOperationsSessionRepository.java @@ -71,9 +71,7 @@ import org.springframework.util.Assert; * command. An example of how each session is stored can be seen below. *

* - *
- *     HMSET spring:session:sessions: creationTime 1404360000000 maxInactiveInterval 1800 lastAccessedTime 1404360000000 sessionAttr: someAttrValue sessionAttr2: someAttrValue2
- * 
+ * {@code HMSET spring:session:sessions: creationTime 1404360000000 maxInactiveInterval 1800 lastAccessedTime 1404360000000 sessionAttr: someAttrValue sessionAttr2: someAttrValue2} * *

* An expiration is associated to each session using the * - *

- *    EXPIRE spring:session:sessions: 1800
- * 
+ * {@code EXPIRE spring:session:sessions: 1800} * *

* The {@link RedisSession} keeps track of the properties that have changed and @@ -94,19 +90,19 @@ import org.springframework.util.Assert; * would be executed upon saving: *

* - *
+ * {@code
  *     HMSET spring:session:sessions: sessionAttr2: newValue
  *     EXPIRE spring:session:sessions: 1800
- * 
+ * } * * Each session expiration is also tracked to the nearest minute. This allows a * background task to cleanup expired sessions in a deterministic fashion. For * example: * - *
+ * {@code
  *     SADD spring:session:expirations: 
  *     EXPIRE spring:session:expirations: 1800
- * 
+ * } * * The Redis expiration is still placed on each key to ensure that if the server * is down when the session expires, it is still cleaned up. diff --git a/spring-session/src/main/java/org/springframework/session/data/redis/config/annotation/web/http/EnableRedisHttpSession.java b/spring-session/src/main/java/org/springframework/session/data/redis/config/annotation/web/http/EnableRedisHttpSession.java index 2436671d..cb289307 100644 --- a/spring-session/src/main/java/org/springframework/session/data/redis/config/annotation/web/http/EnableRedisHttpSession.java +++ b/spring-session/src/main/java/org/springframework/session/data/redis/config/annotation/web/http/EnableRedisHttpSession.java @@ -30,11 +30,11 @@ import org.springframework.data.redis.connection.RedisConnectionFactory; * must be provided. For example: * * - * @Configuration - * @EnableRedisHttpSession + * {@literal @Configuration} + * {@literal @EnableRedisHttpSession} * public class RedisHttpSessionConfig { * - * @Bean + * {@literal @Bean} * public JedisConnectionFactory connectionFactory() throws Exception { * return new JedisConnectionFactory(); * } diff --git a/spring-session/src/main/java/org/springframework/session/web/context/AbstractHttpSessionApplicationInitializer.java b/spring-session/src/main/java/org/springframework/session/web/context/AbstractHttpSessionApplicationInitializer.java index a16e0564..1f53ff14 100644 --- a/spring-session/src/main/java/org/springframework/session/web/context/AbstractHttpSessionApplicationInitializer.java +++ b/spring-session/src/main/java/org/springframework/session/web/context/AbstractHttpSessionApplicationInitializer.java @@ -46,25 +46,25 @@ import org.springframework.web.filter.DelegatingFilterProxy; * *

* By default the {@link DelegatingFilterProxy} is registered with support for - * asynchronous requests, but can be enabled by overriding {@link #isAsyncSecuritySupported()} and - * {@link #getSecurityDispatcherTypes()}. + * asynchronous requests, but can be enabled by overriding {@link #isAsyncSessionSupported()} and + * {@link #getSessionDispatcherTypes()}. *

* *

* Additional configuration before and after the springSecurityFilterChain can * be added by overriding - * {@link #afterSpringSecurityFilterChain(ServletContext)}. + * {@link #afterSessionRepositoryFilter(ServletContext)}. *

* * *

Caveats

*

- * Subclasses of AbstractDispatcherServletInitializer will register their + * Subclasses of {@code AbstractDispatcherServletInitializer} will register their * filters before any other {@link Filter}. This means that you will typically - * want to ensure subclasses of AbstractDispatcherServletInitializer are invoked + * want to ensure subclasses of {@code AbstractDispatcherServletInitializer} are invoked * first. This can be done by ensuring the {@link Order} or {@link Ordered} of - * AbstractDispatcherServletInitializer are sooner than subclasses of - * {@link AbstractSecurityWebApplicationInitializer}. + * {@code AbstractDispatcherServletInitializer} are sooner than subclasses of + * {@code AbstractSecurityWebApplicationInitializer}. *

* * @author Rob Winch @@ -96,7 +96,7 @@ public abstract class AbstractHttpSessionApplicationInitializer implements WebAp * Creates a new instance that will instantiate the * {@link ContextLoaderListener} with the specified classes. * - * @param configurationClasses + * @param configurationClasses {@code @Configuration} classes that will be used to configure the context */ protected AbstractHttpSessionApplicationInitializer(Class... configurationClasses) { this.configurationClasses = configurationClasses; @@ -227,7 +227,7 @@ public abstract class AbstractHttpSessionApplicationInitializer implements WebAp /** - * Return the to use the DispatcherServlet's + * Return the {@code } to use the DispatcherServlet's * {@link WebApplicationContext} to find the {@link DelegatingFilterProxy} * or null to use the parent {@link ApplicationContext}. * @@ -238,7 +238,7 @@ public abstract class AbstractHttpSessionApplicationInitializer implements WebAp * use the DispatcherServlet's {@link WebApplicationContext}. *

* - * @return the of the DispatcherServlet to use its + * @return the {@code } of the DispatcherServlet to use its * {@link WebApplicationContext} or null (default) to use the parent * {@link ApplicationContext}. */ @@ -264,7 +264,7 @@ public abstract class AbstractHttpSessionApplicationInitializer implements WebAp /** * Get the {@link DispatcherType} for the springSessionRepositoryFilter. - * @return + * @return the {@link DispatcherType} for the filter */ protected EnumSet getSessionDispatcherTypes() { return EnumSet.of(DispatcherType.REQUEST, DispatcherType.ERROR, DispatcherType.ASYNC); diff --git a/spring-session/src/main/java/org/springframework/session/web/http/CookieHttpSessionStrategy.java b/spring-session/src/main/java/org/springframework/session/web/http/CookieHttpSessionStrategy.java index 5abfe0b9..a7fb7990 100644 --- a/spring-session/src/main/java/org/springframework/session/web/http/CookieHttpSessionStrategy.java +++ b/spring-session/src/main/java/org/springframework/session/web/http/CookieHttpSessionStrategy.java @@ -99,8 +99,8 @@ import org.springframework.session.Session; * attributes. An example is provided below: *

* - * - * HttpSessionManager sessionManager = + * {@code + * HttpSessionManager sessionManager = * (HttpSessionManager) req.getAttribute(HttpSessionManager.class.getName()); * SessionRepository repo = * (SessionRepository) req.getAttribute(SessionRepository.class.getName()); @@ -140,7 +140,7 @@ import org.springframework.session.Session; * req.setAttribute("currentAccount", currentAccount); * req.setAttribute("addAccountUrl", sessionManager.encodeURL(contextPath, newSessionAlias)); * req.setAttribute("accounts", accounts); - * + * } * * * @since 1.0 @@ -239,7 +239,7 @@ public final class CookieHttpSessionStrategy implements MultiHttpSessionStrategy /** * Sets the name of the cookie to be used - * @param cookieName + * @param cookieName the name of the cookie to be used */ public void setCookieName(String cookieName) { if(cookieName == null) { diff --git a/spring-session/src/main/java/org/springframework/session/web/socket/config/annotation/AbstractSessionWebSocketMessageBrokerConfigurer.java b/spring-session/src/main/java/org/springframework/session/web/socket/config/annotation/AbstractSessionWebSocketMessageBrokerConfigurer.java index 3fdb1516..a1987868 100644 --- a/spring-session/src/main/java/org/springframework/session/web/socket/config/annotation/AbstractSessionWebSocketMessageBrokerConfigurer.java +++ b/spring-session/src/main/java/org/springframework/session/web/socket/config/annotation/AbstractSessionWebSocketMessageBrokerConfigurer.java @@ -47,18 +47,18 @@ import org.springframework.web.socket.server.HandshakeInterceptor; *

Example usage

* * - * @Configuration - * @EnableScheduling - * @EnableWebSocketMessageBroker - * public class WebSocketConfig extends AbstractSessionWebSocketMessageBrokerConfigurer { + * {@literal @Configuration} + * {@literal @EnableScheduling} + * {@literal @EnableWebSocketMessageBroker} + * {@literal public class WebSocketConfig extends AbstractSessionWebSocketMessageBrokerConfigurer} { * - * @Override + * {@literal @Override} * protected void configureStompEndpoints(StompEndpointRegistry registry) { * registry.addEndpoint("/messages") * .withSockJS(); * } * - * @Override + * {@literal @Override} * public void configureMessageBroker(MessageBrokerRegistry registry) { * registry.enableSimpleBroker("/queue/", "/topic/"); * registry.setApplicationDestinationPrefixes("/app"); diff --git a/spring-session/src/main/java/org/springframework/session/web/socket/server/SessionRepositoryMessageInterceptor.java b/spring-session/src/main/java/org/springframework/session/web/socket/server/SessionRepositoryMessageInterceptor.java index c10b82f3..b09e3095 100644 --- a/spring-session/src/main/java/org/springframework/session/web/socket/server/SessionRepositoryMessageInterceptor.java +++ b/spring-session/src/main/java/org/springframework/session/web/socket/server/SessionRepositoryMessageInterceptor.java @@ -49,7 +49,6 @@ import org.springframework.web.socket.server.HandshakeInterceptor; * intercepting messages to ensure the * {@link ExpiringSession#getLastAccessedTime()} is updated. * - * *
  • * Intercepts {@link Message}'s that are have {@link SimpMessageType} that * corresponds to {@link #setMatchingMessageTypes(Set)} and updates the last