org.springframework.session

Class MapSession

java.lang.Object

org.springframework.session.MapSession

All Implemented Interfaces:

java.io.Serializable, Session

public final class MapSession
extends java.lang.Object
implements Session, java.io.Serializable

A Session implementation that is backed by a Map. The defaults for the properties are:

• id - a secure random generated id
• creationTime - the moment the MapSession was instantiated
• lastAccessedTime - the moment the MapSession was instantiated
• maxInactiveInterval - 30 minutes

This implementation has no synchronization, so it is best to use the copy constructor when working on multiple threads.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS Default setMaxInactiveInterval(Duration) (30 minutes).

Constructor Summary

Constructors

Constructor and Description
MapSession() Creates a new instance with a secure randomly generated identifier.
MapSession(Session session) Creates a new instance from the provided Session.
MapSession(java.lang.String id) Creates a new instance with the specified id.

Method Summary

Modifier and Type	Method and Description
java.lang.String	changeSessionId() Changes the session id.
boolean	equals(java.lang.Object obj)
<T> T	getAttribute(java.lang.String attributeName) Gets the Object associated with the specified name or null if no Object is associated to that name.
java.util.Set<java.lang.String>	getAttributeNames() Gets the attribute names that have a value associated with it.
java.time.Instant	getCreationTime() Gets the time when this session was created.
java.lang.String	getId() Gets a unique string that identifies the Session.
java.time.Instant	getLastAccessedTime() Gets the last time this Session was accessed.
java.time.Duration	getMaxInactiveInterval() Gets the maximum inactive interval between requests before this session will be invalidated.
java.lang.String	getOriginalId() Get the original session id.
int	hashCode()
boolean	isExpired() Returns true if the session is expired.
void	removeAttribute(java.lang.String attributeName) Removes the attribute with the provided attribute name.
void	setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Sets the attribute value for the provided attribute name.
void	setCreationTime(java.time.Instant creationTime) Sets the time that this Session was created.
void	setId(java.lang.String id) Sets the identifier for this Session.
void	setLastAccessedTime(java.time.Instant lastAccessedTime) Sets the last accessed time.
void	setMaxInactiveInterval(java.time.Duration interval) Sets the maximum inactive interval between requests before this session will be invalidated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.session.Session

getAttributeOrDefault, getRequiredAttribute

Field Detail

DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS

public static final int DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS

Default setMaxInactiveInterval(Duration) (30 minutes).

See Also:

Constant Field Values

Constructor Detail

MapSession

public MapSession()

Creates a new instance with a secure randomly generated identifier.

MapSession

public MapSession(java.lang.String id)

Creates a new instance with the specified id. This is preferred to the default constructor when the id is known to prevent unnecessary consumption on entropy which can be slow.

Parameters:

id - the identifier to use

MapSession

public MapSession(Session session)

Creates a new instance from the provided Session.

Parameters:

session - the Session to initialize this Session with. Cannot be null.

Method Detail

setLastAccessedTime

public void setLastAccessedTime(java.time.Instant lastAccessedTime)

Description copied from interface: Session

Sets the last accessed time.

Specified by:

setLastAccessedTime in interface Session

Parameters:

lastAccessedTime - the last accessed time

getCreationTime

public java.time.Instant getCreationTime()

Description copied from interface: Session

Gets the time when this session was created.

Specified by:

getCreationTime in interface Session

Returns:

the time when this session was created.

getId

public java.lang.String getId()

Description copied from interface: Session

Gets a unique string that identifies the Session.

Specified by:

getId in interface Session

Returns:

a unique string that identifies the Session

getOriginalId

public java.lang.String getOriginalId()

Get the original session id.

Returns:

the original session id

See Also:

changeSessionId()

changeSessionId

public java.lang.String changeSessionId()

Description copied from interface: Session

Changes the session id. After invoking the Session.getId() will return a new identifier.

Specified by:

changeSessionId in interface Session

Returns:

the new session id which Session.getId() will now return

getLastAccessedTime

public java.time.Instant getLastAccessedTime()

Description copied from interface: Session

Gets the last time this Session was accessed.

Specified by:

getLastAccessedTime in interface Session

Returns:

the last time the client sent a request associated with the session

setMaxInactiveInterval

public void setMaxInactiveInterval(java.time.Duration interval)

Description copied from interface: Session

Sets the maximum inactive interval between requests before this session will be invalidated. A negative time indicates that the session will never timeout.

Specified by:

setMaxInactiveInterval in interface Session

Parameters:

interval - the amount of time that the Session should be kept alive between client requests.

getMaxInactiveInterval

public java.time.Duration getMaxInactiveInterval()

Description copied from interface: Session

Gets the maximum inactive interval between requests before this session will be invalidated. A negative time indicates that the session will never timeout.

Specified by:

getMaxInactiveInterval in interface Session

Returns:

the maximum inactive interval between requests before this session will be invalidated. A negative time indicates that the session will never timeout.

isExpired

public boolean isExpired()

Description copied from interface: Session

Returns true if the session is expired.

Specified by:

isExpired in interface Session

Returns:

true if the session is expired, else false.

getAttribute

public <T> T getAttribute(java.lang.String attributeName)

Description copied from interface: Session

Gets the Object associated with the specified name or null if no Object is associated to that name.

Specified by:

getAttribute in interface Session

Type Parameters:

T - the return type of the attribute

Parameters:

attributeName - the name of the attribute to get

Returns:

the Object associated with the specified name or null if no Object is associated to that name

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Description copied from interface: Session

Gets the attribute names that have a value associated with it. Each value can be passed into Session.getAttribute(String) to obtain the attribute value.

Specified by:

getAttributeNames in interface Session

Returns:

the attribute names that have a value associated with it.

See Also:

Session.getAttribute(String)

setAttribute

public void setAttribute(java.lang.String attributeName,
                         java.lang.Object attributeValue)

Description copied from interface: Session

Sets the attribute value for the provided attribute name. If the attributeValue is null, it has the same result as removing the attribute with Session.removeAttribute(String) .

Specified by:

setAttribute in interface Session

Parameters:

attributeName - the attribute name to set

attributeValue - the value of the attribute to set. If null, the attribute will be removed.

removeAttribute

public void removeAttribute(java.lang.String attributeName)

Description copied from interface: Session

Removes the attribute with the provided attribute name.

Specified by:

removeAttribute in interface Session

Parameters:

attributeName - the name of the attribute to remove

setCreationTime

public void setCreationTime(java.time.Instant creationTime)

Sets the time that this Session was created. The default is when the Session was instantiated.

Parameters:

creationTime - the time that this Session was created.

setId

public void setId(java.lang.String id)

Sets the identifier for this Session. The id should be a secure random generated value to prevent malicious users from guessing this value. The default is a secure random generated identifier.

Parameters:

id - the identifier for this session.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object