org.springframework.session

Class MapSession

java.lang.Object

org.springframework.session.MapSession

All Implemented Interfaces:

Serializable, ExpiringSession, Session

public final class MapSession
extends Object
implements ExpiringSession, 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

Author:

Rob Winch

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
<T> T	getAttribute(String attributeName) Gets the Object associated with the specified name or null if no Object is associated to that name.
Set<String>	getAttributeNames() Gets the attribute names that have a value associated with it.
long	getCreationTime() Gets the time when this session was created in milliseconds since midnight of 1/1/1970 GMT.
String	getId() Gets a unique string that identifies the Session.
long	getLastAccessedTime() Gets the last time this Session was accessed expressed in milliseconds since midnight of 1/1/1970 GMT.
int	getMaxInactiveIntervalInSeconds() Gets the maximum inactive interval in seconds between requests before this session will be invalidated.
int	hashCode()
boolean	isExpired() Returns true if the session is expired.
void	removeAttribute(String attributeName) Removes the attribute with the provided attribute name.
void	setAttribute(String attributeName, Object attributeValue) Sets the attribute value for the provided attribute name.
void	setCreationTime(long creationTime) Sets the time that this Session was created in milliseconds since midnight of 1/1/1970 GMT.
void	setId(String id) Sets the identifier for this Session.
void	setLastAccessedTime(long lastAccessedTime) Sets the last accessed time in milliseconds since midnight of 1/1/1970 GMT.
void	setMaxInactiveIntervalInSeconds(int interval) Sets the maximum inactive interval in seconds between requests before this session will be invalidated.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS

public static final int DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS

Default setMaxInactiveIntervalInSeconds(int) (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(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(ExpiringSession 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(long lastAccessedTime)

Description copied from interface: ExpiringSession

Sets the last accessed time in milliseconds since midnight of 1/1/1970 GMT.

Specified by:

setLastAccessedTime in interface ExpiringSession

Parameters:

lastAccessedTime - the last accessed time in milliseconds since midnight of 1/1/1970 GMT

getCreationTime

public long getCreationTime()

Description copied from interface: ExpiringSession

Gets the time when this session was created in milliseconds since midnight of 1/1/1970 GMT.

Specified by:

getCreationTime in interface ExpiringSession

Returns:

the time when this session was created in milliseconds since midnight of 1/1/1970 GMT.

getId

public 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

getLastAccessedTime

public long getLastAccessedTime()

Description copied from interface: ExpiringSession

Gets the last time this Session was accessed expressed in milliseconds since midnight of 1/1/1970 GMT.

Specified by:

getLastAccessedTime in interface ExpiringSession

Returns:

the last time the client sent a request associated with the session expressed in milliseconds since midnight of 1/1/1970 GMT

setMaxInactiveIntervalInSeconds

public void setMaxInactiveIntervalInSeconds(int interval)

Description copied from interface: ExpiringSession

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

Specified by:

setMaxInactiveIntervalInSeconds in interface ExpiringSession

Parameters:

interval - the number of seconds that the Session should be kept alive between client requests.

getMaxInactiveIntervalInSeconds

public int getMaxInactiveIntervalInSeconds()

Description copied from interface: ExpiringSession

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

Specified by:

getMaxInactiveIntervalInSeconds in interface ExpiringSession

Returns:

the maximum inactive interval in seconds 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: ExpiringSession

Returns true if the session is expired.

Specified by:

isExpired in interface ExpiringSession

Returns:

true if the session is expired, else false.

getAttribute

public <T> T getAttribute(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 Set<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(String attributeName,
                         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(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(long creationTime)

Sets the time that this Session was created in milliseconds since midnight of 1/1/1970 GMT. The default is when the Session was instantiated.

Parameters:

creationTime - the time that this Session was created in milliseconds since midnight of 1/1/1970 GMT.

setId

public void setId(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(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object