Fix Javadoc for JDK8

Fixes gh-84
This commit is contained in:
Christopher Smith
2014-12-22 13:26:51 -06:00
committed by Rob Winch
parent 900b9174d3
commit 873f4bacd6
7 changed files with 31 additions and 36 deletions

View File

@@ -61,7 +61,7 @@ public class MapSessionRepository implements SessionRepository<ExpiringSession>
/**
* 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);

View File

@@ -71,9 +71,7 @@ import org.springframework.util.Assert;
* command</a>. An example of how each session is stored can be seen below.
* </p>
*
* <pre>
* HMSET spring:session:sessions:<session-id> creationTime 1404360000000 maxInactiveInterval 1800 lastAccessedTime 1404360000000 sessionAttr:<attrName> someAttrValue sessionAttr2:<attrName> someAttrValue2
* </pre>
* {@code HMSET spring:session:sessions:<session-id> creationTime 1404360000000 maxInactiveInterval 1800 lastAccessedTime 1404360000000 sessionAttr:<attrName> someAttrValue sessionAttr2:<attrName> someAttrValue2}
*
* <p>
* An expiration is associated to each session using the <a
@@ -82,9 +80,7 @@ import org.springframework.util.Assert;
* . For example:
* </p>
*
* <pre>
* EXPIRE spring:session:sessions:<session-id> 1800
* </pre>
* {@code EXPIRE spring:session:sessions:<session-id> 1800}
*
* <p>
* 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:
* </p>
*
* <pre>
* {@code
* HMSET spring:session:sessions:<session-id> sessionAttr2:<attrName> newValue
* EXPIRE spring:session:sessions:<session-id> 1800
* </pre>
* }
*
* 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:
*
* <pre>
* {@code
* SADD spring:session:expirations:<expire-rounded-up-to-nearest-minute> <session-id>
* EXPIRE spring:session:expirations:<expire-rounded-up-to-nearest-minute> 1800
* </pre>
* }
*
* 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.

View File

@@ -30,11 +30,11 @@ import org.springframework.data.redis.connection.RedisConnectionFactory;
* must be provided. For example:
*
* <code>
* &#064;Configuration
* &#064;EnableRedisHttpSession
* {@literal @Configuration}
* {@literal @EnableRedisHttpSession}
* public class RedisHttpSessionConfig {
*
* @Bean
* {@literal @Bean}
* public JedisConnectionFactory connectionFactory() throws Exception {
* return new JedisConnectionFactory();
* }

View File

@@ -46,25 +46,25 @@ import org.springframework.web.filter.DelegatingFilterProxy;
*
* <p>
* 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()}.
* </p>
*
* <p>
* Additional configuration before and after the springSecurityFilterChain can
* be added by overriding
* {@link #afterSpringSecurityFilterChain(ServletContext)}.
* {@link #afterSessionRepositoryFilter(ServletContext)}.
* </p>
*
*
* <h2>Caveats</h2>
* <p>
* 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}.
* </p>
*
* @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 <servlet-name> to use the DispatcherServlet's
* Return the {@code <servlet-name>} 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}.
* </p>
*
* @return the <servlet-name> of the DispatcherServlet to use its
* @return the {@code <servlet-name>} 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<DispatcherType> getSessionDispatcherTypes() {
return EnumSet.of(DispatcherType.REQUEST, DispatcherType.ERROR, DispatcherType.ASYNC);

View File

@@ -99,8 +99,8 @@ import org.springframework.session.Session;
* attributes. An example is provided below:
* </p>
*
* <code>
* HttpSessionManager sessionManager =
* {@code
* HttpSessionManager sessionManager =
* (HttpSessionManager) req.getAttribute(HttpSessionManager.class.getName());
* SessionRepository<Session> repo =
* (SessionRepository<Session>) 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);
* </code>
* }
*
*
* @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) {

View File

@@ -47,18 +47,18 @@ import org.springframework.web.socket.server.HandshakeInterceptor;
* <p>Example usage</p>
*
* <code>
* @Configuration
* @EnableScheduling
* @EnableWebSocketMessageBroker
* public class WebSocketConfig<S extends ExpiringSession> extends AbstractSessionWebSocketMessageBrokerConfigurer<S> {
* {@literal @Configuration}
* {@literal @EnableScheduling}
* {@literal @EnableWebSocketMessageBroker}
* {@literal public class WebSocketConfig<S extends ExpiringSession> extends AbstractSessionWebSocketMessageBrokerConfigurer<S>} {
*
* @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");

View File

@@ -49,7 +49,6 @@ import org.springframework.web.socket.server.HandshakeInterceptor;
* intercepting messages to ensure the
* {@link ExpiringSession#getLastAccessedTime()} is updated.
* </li>
* </li>
* <li>
* Intercepts {@link Message}'s that are have {@link SimpMessageType} that
* corresponds to {@link #setMatchingMessageTypes(Set)} and updates the last