org.springframework.web.server.session

Class DefaultWebSession

java.lang.Object

org.springframework.web.server.session.DefaultWebSession

All Implemented Interfaces:

java.io.Serializable, ConfigurableWebSession, WebSession

public class DefaultWebSession
extends java.lang.Object
implements ConfigurableWebSession, java.io.Serializable

Default implementation of WebSession.

Since:

5.0

Author:

Rossen Stoyanchev

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultWebSession.State

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private java.time.Clock	clock
private java.time.Instant	creationTime
private java.lang.String	id
private java.time.Instant	lastAccessTime
private java.time.Duration	maxIdleTime
private java.util.function.Supplier<<any>>	saveOperation
private static long	serialVersionUID
private java.util.concurrent.atomic.AtomicReference<DefaultWebSession.State>	state

Constructor Summary

Constructors

Constructor and Description
DefaultWebSession(java.lang.String id, java.time.Clock clock) Constructor to create a new session.
DefaultWebSession(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> attributes, java.time.Clock clock, java.time.Instant creationTime, java.time.Instant lastAccessTime, java.time.Duration maxIdleTime) Constructor to load existing session.

Method Summary

Modifier and Type	Method and Description
<T> java.util.Optional<T>	getAttribute(java.lang.String name) Return the attribute value if present.
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Return a map that holds session attributes.
java.time.Instant	getCreationTime() Return the time when the session was created.
java.lang.String	getId() Return a unique session identifier.
java.time.Instant	getLastAccessTime() Return the last time of session access as a result of user activity such as an HTTP request.
java.time.Duration	getMaxIdleTime() Return the maximum time after the lastAccessTime before a session expires.
protected java.util.function.Supplier<<any>>	getSaveOperation()
boolean	isExpired() Return true if the session expired after maxIdleTime elapsed.
boolean	isStarted() Whether a session with the client has been started explicitly via WebSession.start() or implicitly by adding session attributes.
<any>	save() Save the session persisting attributes (e.g.
void	setLastAccessTime(java.time.Instant lastAccessTime) Update the last access time for user-related session activity.
void	setMaxIdleTime(java.time.Duration maxIdleTime) By default this is set to 30 minutes.
void	setSaveOperation(java.util.function.Supplier<<any>> saveOperation) Set the operation to invoke when WebSession.save() is invoked.
void	start() Force the creation of a session causing the session id to be sent when WebSession.save() is called.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

id

private final java.lang.String id

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

clock

private final java.time.Clock clock

creationTime

private final java.time.Instant creationTime

lastAccessTime

private volatile java.time.Instant lastAccessTime

maxIdleTime

private volatile java.time.Duration maxIdleTime

state

private java.util.concurrent.atomic.AtomicReference<DefaultWebSession.State> state

saveOperation

private transient volatile java.util.function.Supplier<<any>> saveOperation

Constructor Detail

DefaultWebSession

public DefaultWebSession(java.lang.String id,
                         java.time.Clock clock)

Constructor to create a new session.

Parameters:

id - the session id

clock - for access to current time

DefaultWebSession

public DefaultWebSession(java.lang.String id,
                         java.util.Map<java.lang.String,java.lang.Object> attributes,
                         java.time.Clock clock,
                         java.time.Instant creationTime,
                         java.time.Instant lastAccessTime,
                         java.time.Duration maxIdleTime)

Constructor to load existing session.

Parameters:

id - the session id

attributes - the attributes of the session

clock - for access to current time

creationTime - the creation time

lastAccessTime - the last access time

maxIdleTime - the configured maximum session idle time

Method Detail

getId

public java.lang.String getId()

Description copied from interface: WebSession

Return a unique session identifier.

Specified by:

getId in interface WebSession

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Description copied from interface: WebSession

Return a map that holds session attributes.

Specified by:

getAttributes in interface WebSession

getAttribute

public <T> java.util.Optional<T> getAttribute(java.lang.String name)

Description copied from interface: WebSession

Return the attribute value if present.

Specified by:

getAttribute in interface WebSession

Type Parameters:

T - the attribute type

Parameters:

name - the attribute name

Returns:

the attribute value

getCreationTime

public java.time.Instant getCreationTime()

Description copied from interface: WebSession

Return the time when the session was created.

Specified by:

getCreationTime in interface WebSession

setLastAccessTime

public void setLastAccessTime(java.time.Instant lastAccessTime)

Description copied from interface: ConfigurableWebSession

Update the last access time for user-related session activity.

Specified by:

setLastAccessTime in interface ConfigurableWebSession

Parameters:

lastAccessTime - the time of access

getLastAccessTime

public java.time.Instant getLastAccessTime()

Description copied from interface: WebSession

Return the last time of session access as a result of user activity such as an HTTP request. Together with maxIdleTimeInSeconds this helps to determine when a session is expired.

Specified by:

getLastAccessTime in interface WebSession

setMaxIdleTime

public void setMaxIdleTime(java.time.Duration maxIdleTime)

By default this is set to 30 minutes.

Specified by:

setMaxIdleTime in interface WebSession

Parameters:

maxIdleTime - the max idle time

getMaxIdleTime

public java.time.Duration getMaxIdleTime()

Description copied from interface: WebSession

Return the maximum time after the lastAccessTime before a session expires. A negative time indicates the session doesn't expire.

Specified by:

getMaxIdleTime in interface WebSession

setSaveOperation

public void setSaveOperation(java.util.function.Supplier<<any>> saveOperation)

Description copied from interface: ConfigurableWebSession

Set the operation to invoke when WebSession.save() is invoked.

Specified by:

setSaveOperation in interface ConfigurableWebSession

Parameters:

saveOperation - the save operation

getSaveOperation

protected java.util.function.Supplier<<any>> getSaveOperation()

start

public void start()

Description copied from interface: WebSession

Force the creation of a session causing the session id to be sent when WebSession.save() is called.

Specified by:

start in interface WebSession

isStarted

public boolean isStarted()

Description copied from interface: WebSession

Whether a session with the client has been started explicitly via WebSession.start() or implicitly by adding session attributes. If "false" then the session id is not sent to the client and the WebSession.save() method is essentially a no-op.

Specified by:

isStarted in interface WebSession

save

public <any> save()

Description copied from interface: WebSession

Save the session persisting attributes (e.g. if stored remotely) and also sending the session id to the client if the session is new.

Note that a session must be started explicitly via WebSession.start() or implicitly by adding attributes or otherwise this method has no effect.

Specified by:

save in interface WebSession

Returns:

Mono to indicate completion with success or error

Typically this method should be automatically invoked just before the response is committed so applications don't have to by default.

isExpired

public boolean isExpired()

Description copied from interface: WebSession

Return true if the session expired after maxIdleTime elapsed.

Typically expiration checks should be automatically made when a session is accessed, a new WebSession instance created if necessary, at the start of request processing so that applications don't have to worry about expired session by default.

Specified by:

isExpired in interface WebSession