org.springframework.session

Interface Session

All Known Subinterfaces:

ExpiringSession

All Known Implementing Classes:

AbstractGemFireOperationsSessionRepository.GemFireSession, MapSession, MongoExpiringSession

public interface Session

Provides a way to identify a user in an agnostic way. This allows the session to be used by an HttpSession, WebSocket Session, or even non web related sessions.

Since:

1.0

Author:

Rob Winch

Method Summary

Modifier and Type	Method and Description
<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.
String	getId() Gets a unique string that identifies the Session.
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.

Method Detail

getId

String getId()

Gets a unique string that identifies the Session.

Returns:

a unique string that identifies the Session

getAttribute

<T> T getAttribute(String attributeName)

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

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

Set<String> getAttributeNames()

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

Returns:

the attribute names that have a value associated with it.

See Also:

getAttribute(String)

setAttribute

void setAttribute(String attributeName,
                  Object attributeValue)

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

Parameters:

attributeName - the attribute name to set

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

removeAttribute

void removeAttribute(String attributeName)

Removes the attribute with the provided attribute name.

Parameters:

attributeName - the name of the attribute to remove