com.pingidentity.pa.sdk.identity

Interface SessionStateSupport

public interface SessionStateSupport

SessionStateSupport provides access to persistent data across exchanges.

The session state data is stored in a cookie. To store session state data, you must have a web application with a web session configured.

When using attributes, implementers should be prepared to reacquire data that was stored in previous exchanges if it is not present.

• Server-side attribute caching may cause cache entries to be deleted if cache limits are exceeded.
• When using server-side attribute caching in a cluster, requests to other nodes may result in a cache miss
• Not all configurations support persistent session state. API configured applications are a current example of this.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAttributeNames() Returns an unmodifiable Set of the session attribute name.
Map<String,com.fasterxml.jackson.databind.JsonNode>	getAttributes() Returns an unmodifiable Map containing the session attributes.
com.fasterxml.jackson.databind.JsonNode	getAttributeValue(String name) Returns the attribute value for the given name or null if not present.
void	removeAttribute(String name) Removes a session attribute.
void	setAttribute(String name, com.fasterxml.jackson.databind.JsonNode value) Sets a session attribute.

Method Detail

getAttributes

Map<String,com.fasterxml.jackson.databind.JsonNode> getAttributes()

Returns an unmodifiable Map containing the session attributes. Attempts to modify the Map returned from this method will cause an UnsupportedOperationException to be thrown. Later changes to attributes through setAttribute(java.lang.String, com.fasterxml.jackson.databind.JsonNode) and removeAttribute(java.lang.String)will not be reflected in the map returned from this method.

Returns:

an unmodifiable Map containing the identity attributes;

getAttributeNames

Set<String> getAttributeNames()

Returns an unmodifiable Set of the session attribute name. Attempts to modify the Set returned from this method will cause an UnsupportedOperationException to be thrown. Later changes to attributes through setAttribute(java.lang.String, com.fasterxml.jackson.databind.JsonNode) and removeAttribute(java.lang.String)will not be reflected in the map returned from this method.

Returns:

the names of the session attributes.

getAttributeValue

com.fasterxml.jackson.databind.JsonNode getAttributeValue(String name)

Returns the attribute value for the given name or null if not present.

Parameters:

name - the attribute name

Returns:

the attribute value

setAttribute

void setAttribute(String name,
                  com.fasterxml.jackson.databind.JsonNode value)

Sets a session attribute. If the application configuration supports persistence, the value may be available on subsequent exchanges. See SessionStateSupport class level documentation.

Attributes should be kept as small as possible. Depending on configuration, attributes may be stored in a cookie in which browsers may limit the maximum size.

Parameters:

name - the attribute name

value - the attribute value

removeAttribute

void removeAttribute(String name)

Removes a session attribute.

Parameters:

name - the attribute name