org.forgerock.http.servlet

Class ServletSession

java.lang.Object

java.util.AbstractMap<String,Object>

org.forgerock.http.servlet.ServletSession

All Implemented Interfaces:

Map<String,Object>, Session

public final class ServletSession
extends AbstractMap<String,Object>
implements Session

Exposes the session managed by the servlet container as an exchange session. This implementation will get a servlet session if already allocated, otherwise will not create one until an attempt is made to put an attribute in it.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ServletSession(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
boolean	isEmpty()
Object	put(String key, Object value)
Object	remove(Object key)
void	save(Response response) Save the session state to the response.
int	size()

Methods inherited from class java.util.AbstractMap

clone, containsValue, equals, hashCode, keySet, putAll, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, getOrDefault, hashCode, keySet, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll, values

Constructor Detail

ServletSession

public ServletSession(javax.servlet.http.HttpServletRequest request)

Method Detail

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

Overrides:

clear in class AbstractMap<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class AbstractMap<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

Specified by:

entrySet in class AbstractMap<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class AbstractMap<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

Overrides:

isEmpty in class AbstractMap<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class AbstractMap<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class AbstractMap<String,Object>

size

public int size()

Specified by:

size in interface Map<String,Object>

Overrides:

size in class AbstractMap<String,Object>

save

public void save(Response response)
          throws IOException

Description copied from interface: Session

Save the session state to the response.

Specified by:

save in interface Session

Parameters:

response - The Response instance to write the session state to.

Throws:

IOException - If an I/O error occurs.