com.opensymphony.webwork.dispatcher
Class SessionMap

java.lang.Object
  extended byjava.util.AbstractMap
      extended bycom.opensymphony.webwork.dispatcher.SessionMap
All Implemented Interfaces:
Map, Serializable

public class SessionMap
extends AbstractMap
implements 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.

Author:
Rickard ?berg, Bill Lynch (docs)
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.util.Map
Map.Entry
 
Constructor Summary
SessionMap(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.
 Set entrySet()
          Returns a Set of attributes from the http session.
 Object get(Object key)
          Returns the session attribute associated with the given key or null if it doesn't exist.
 Object put(Object key, Object value)
          Saves an attribute in the session.
 Object remove(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
 

Constructor Detail

SessionMap

public SessionMap(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

clear

public void clear()
Removes all attributes from the session as well as clears entries in this map.

Specified by:
clear in interface Map

entrySet

public Set entrySet()
Returns a Set of attributes from the http session.

Specified by:
entrySet in interface Map
Returns:
a Set of attributes from the http session.

get

public Object get(Object key)
Returns the session attribute associated with the given key or null if it doesn't exist.

Specified by:
get in interface Map
Parameters:
key - the name of the session attribute.
Returns:
the session attribute or null if it doesn't exist.

put

public Object put(Object key,
                  Object value)
Saves an attribute in the session.

Specified by:
put in interface Map
Parameters:
key - the name of the session attribute.
value - the value to set.
Returns:
the object that was just set.

remove

public Object remove(Object key)
Removes the specified session attribute.

Specified by:
remove in interface Map
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).

WebWork Project Page