org.apache.struts2.dispatcher
Class SessionMap

java.lang.Object
  java.util.AbstractMap
      org.apache.struts2.dispatcher.SessionMap

All Implemented Interfaces:

java.io.Serializable, java.util.Map

public class SessionMap
extends java.util.AbstractMap
implements java.io.Serializable

A simple implementation of the Map interface to handle a collection of HTTP session attributes. The entrySet() method enumerates over all session attributes and creates a Set of entries. Note, this will occur lazily - only when the entry set is asked for.

See Also:

Serialized Form

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

protected java.util.Set<java.lang.Object>	entries
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpSession	session

Constructor Summary

SessionMap(javax.servlet.http.HttpServletRequest request)
Creates a new session map given a http servlet request.

Method Summary

void	clear() Removes all attributes from the session as well as clears entries in this map.
java.util.Set	entrySet() Returns a Set of attributes from the http session.
java.lang.Object	get(java.lang.Object key) Returns the session attribute associated with the given key or null if it doesn't exist.
void	invalidate() Invalidate the http session.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Saves an attribute in the session.
java.lang.Object	remove(java.lang.Object key) Removes the specified session attribute.

Methods inherited from class java.util.AbstractMap

clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

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

Field Detail

session

protected javax.servlet.http.HttpSession session

entries

protected java.util.Set<java.lang.Object> entries

request

protected javax.servlet.http.HttpServletRequest request

Constructor Detail

SessionMap

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

Creates a new session map given a http servlet request. Note, ths enumeration of request attributes will occur when the map entries are asked for.

Parameters:

request - the http servlet request object.

Method Detail

invalidate

public void invalidate()

Invalidate the http session.

clear

public void clear()

Removes all attributes from the session as well as clears entries in this map.

Specified by:

clear in interface java.util.Map

Overrides:

clear in class java.util.AbstractMap

entrySet

public java.util.Set entrySet()

Returns a Set of attributes from the http session.

Specified by:

entrySet in interface java.util.Map

Specified by:

entrySet in class java.util.AbstractMap

Returns:

a Set of attributes from the http session.

get

public java.lang.Object get(java.lang.Object key)

Returns the session attribute associated with the given key or null if it doesn't exist.

Specified by:

get in interface java.util.Map

Overrides:

get in class java.util.AbstractMap

Parameters:

key - the name of the session attribute.

Returns:

the session attribute or null if it doesn't exist.

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Saves an attribute in the session.

Specified by:

put in interface java.util.Map

Overrides:

put in class java.util.AbstractMap

Parameters:

key - the name of the session attribute.

value - the value to set.

Returns:

the object that was just set.

remove

public java.lang.Object remove(java.lang.Object key)

Removes the specified session attribute.

Specified by:

remove in interface java.util.Map

Overrides:

remove in class java.util.AbstractMap

Parameters:

key - the name of the attribute to remove.

Returns:

the value that was removed or null if the value was not found (and hence, not removed).