Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts2.dispatcher
Class SessionMap<K,V>

    java.lang.Object
      java.util.AbstractMap<K,V>
          org.apache.struts2.dispatcher.SessionMap<K,V>

All Implemented Interfaces:
  Serializable, Map<K,V>

    public class SessionMap<K,V>

extends AbstractMap<K,V>
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.

See Also:
  Serialized Form

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>`

Field Summary
`protected Set<Map.Entry<K,V>>` | `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.
`boolean` | `containsKey(Object key)` Checks if the specified session attribute with the given key exists.
`Set<Map.Entry<K,V>>` | `entrySet()` Returns a Set of attributes from the http session.
`V` | `get(Object key)` Returns the session attribute associated with the given key or `null` if it doesn't exist.
`void` | `invalidate()` Invalidate the http session.
`V` | `put(K key, V value)` Saves an attribute in the session.
`V` | `remove(Object key)` Removes the specified session attribute.

Methods inherited from class java.util.AbstractMap
`clone, 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 Set<Map.Entry<K,V>> 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 `Map<K,V>`
  Overrides:
    `clear` in class `AbstractMap<K,V>`

### entrySet

    public Set<Map.Entry<K,V>> entrySet()

  Returns a Set of attributes from the http session.

  Specified by:
    `entrySet` in interface `Map<K,V>`
  Specified by:
    `entrySet` in class `AbstractMap<K,V>`
  Returns:
    a Set of attributes from the http session.

### get

    public V 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<K,V>`
  Overrides:
    `get` in class `AbstractMap<K,V>`
  Parameters:
    `key` - the name of the session attribute.
  Returns:
    the session attribute or `null` if it doesn't exist.

### put

    public V put(K key,
                 V value)

  Saves an attribute in the session.

  Specified by:
    `put` in interface `Map<K,V>`
  Overrides:
    `put` in class `AbstractMap<K,V>`
  Parameters:
    `key` - the name of the session attribute.
    `value` - the value to set.
  Returns:
    the object that was just set.

### remove

    public V remove(Object key)

  Removes the specified session attribute.

  Specified by:
    `remove` in interface `Map<K,V>`
  Overrides:
    `remove` in class `AbstractMap<K,V>`
  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).

### containsKey

    public boolean containsKey(Object key)

  Checks if the specified session attribute with the given key exists.

  Specified by:
    `containsKey` in interface `Map<K,V>`
  Overrides:
    `containsKey` in class `AbstractMap<K,V>`
  Parameters:
    `key` - the name of the session attribute.
  Returns:
    `true` if the session attribute exits or `false` if it doesn't exist.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000–2018 Apache Software Foundation. All rights reserved.