Class SessionProperties

java.lang.Object

org.springframework.boot.session.autoconfigure.SessionProperties

@ConfigurationProperties("spring.session")
public class SessionProperties
extends Object

Configuration properties for Spring Session.

Since:

4.0.0

Author:

Tommy Ludwig, Stephane Nicoll, Vedran Pavic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionProperties.Servlet	Servlet-related properties.

Constructor Summary

Constructors

Constructor	Description
SessionProperties()

Method Summary

Modifier and Type	Method	Description
Duration	determineTimeout(Supplier<Duration> fallbackTimeout)	Deprecated, for removal: This API element is subject to removal in a future version. since 4.0.1 for removal in 4.2.0 in favor of SessionTimeout
SessionProperties.Servlet	getServlet()
@Nullable Duration	getTimeout()
void	setServlet(SessionProperties.Servlet servlet)
void	setTimeout(@Nullable Duration timeout)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SessionProperties

public SessionProperties()

Method Details

getTimeout

public @Nullable Duration getTimeout()

setTimeout

public void setTimeout(@Nullable Duration timeout)

getServlet

public SessionProperties.Servlet getServlet()

setServlet

public void setServlet(SessionProperties.Servlet servlet)

determineTimeout

@Deprecated(since="4.0.1",
            forRemoval=true)
public Duration determineTimeout(Supplier<Duration> fallbackTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0.1 for removal in 4.2.0 in favor of SessionTimeout

Determine the session timeout. If no timeout is configured, the fallbackTimeout is used.

Parameters:

fallbackTimeout - a fallback timeout value if the timeout isn't configured

Returns:

the session timeout