org.springframework.session.data.mongo

Class MongoExpiringSession

java.lang.Object

org.springframework.session.data.mongo.MongoExpiringSession

All Implemented Interfaces:

ExpiringSession, Session

public class MongoExpiringSession
extends Object
implements ExpiringSession

Session object providing additional information about the datetime of expiration.

Since:

1.2

Author:

Jakub Kubrynski

Constructor Summary

Constructors

Constructor and Description
MongoExpiringSession()
MongoExpiringSession(int maxInactiveIntervalInSeconds)
MongoExpiringSession(String id, int maxInactiveIntervalInSeconds)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
<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.
Date	getExpireAt()
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 created)
void	setExpireAt(Date expireAt)
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

Constructor Detail

MongoExpiringSession

public MongoExpiringSession()

MongoExpiringSession

public MongoExpiringSession(int maxInactiveIntervalInSeconds)

MongoExpiringSession

public MongoExpiringSession(String id,
                            int maxInactiveIntervalInSeconds)

Method Detail

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

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

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.

setCreationTime

public void setCreationTime(long created)

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

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.

getExpireAt

public Date getExpireAt()

setExpireAt

public void setExpireAt(Date expireAt)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object