org.xmlactions.web.http

Class HttpSessionManager

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.xmlactions.web.http.HttpSessionManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.EventListener, java.util.Map, javax.servlet.http.HttpSessionBindingListener

public class HttpSessionManager
extends java.util.HashMap
implements javax.servlet.http.HttpSessionBindingListener

Handles http session attributes. These are used to maintain a record of session parameters such as the user login name, the password, if the login was successful and variables related to a statefull session

Since:

22 July 2002

See Also:

"org.xmlactions.sdk.utils.http.HttpProfileSessionManager", Serialized Form

Nested Class Summary

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

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

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

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

Constructor Summary

Constructors

Constructor and Description
HttpSessionManager()

Method Summary

Modifier and Type	Method and Description
static HttpSessionManager	getUserInfo(javax.servlet.http.HttpServletRequest request) This gets the session information related to this session from the HTTP Session.
static void	putUserInfo(javax.servlet.http.HttpServletRequest request, HttpSessionManager userInfo) This stores the user information back into the http session.
static java.lang.Object	retrieve(javax.servlet.http.HttpServletRequest request, java.lang.String key) retrieve an entry from the Hashmap and return it to the user
static void	store(javax.servlet.http.HttpServletRequest request, java.lang.String key, java.lang.Object value) store an entry into the Hashmap and update it back into the session
java.lang.String	toString() This will return an xml list of all entries in the hashmap
void	valueBound(javax.servlet.http.HttpSessionBindingEvent event)
void	valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

HttpSessionManager

public HttpSessionManager()

Method Detail

valueBound

public void valueBound(javax.servlet.http.HttpSessionBindingEvent event)

Specified by:

valueBound in interface javax.servlet.http.HttpSessionBindingListener

Since:

12 July 2001

This gets called when we setAttribute(this) to the session.

valueUnbound

public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)

Specified by:

valueUnbound in interface javax.servlet.http.HttpSessionBindingListener

Since:

12 July 2001

This gets called when the session unbinds this object. Usually when the session is closed or another setAttribute call is made.

store

public static void store(javax.servlet.http.HttpServletRequest request,
                         java.lang.String key,
                         java.lang.Object value)

store an entry into the Hashmap and update it back into the session

Parameters:

request - this is where we store our session variables

key - this is the HashMap Key indentifier

value - this is the Key value

retrieve

public static java.lang.Object retrieve(javax.servlet.http.HttpServletRequest request,
                                        java.lang.String key)

retrieve an entry from the Hashmap and return it to the user

Parameters:

request - this is where we store our session variables

key - this is the HashMap Key indentifier

Returns:

the key value as an Object

getUserInfo

public static HttpSessionManager getUserInfo(javax.servlet.http.HttpServletRequest request)

This gets the session information related to this session from the HTTP Session. Our intention is to store all the information about this user into the session, making it possible to provide a statefull connection between the service and the client.

putUserInfo

public static void putUserInfo(javax.servlet.http.HttpServletRequest request,
                               HttpSessionManager userInfo)

This stores the user information back into the http session. This is part of the statefull process remembering the client information such as login name and password, user id etc.

Parameters:

request - the HttpServletRequest that contains our HttpSessionManager with the HashMap information

userInfo - is the HttpSessionManager we want stored in the http session.

toString

public java.lang.String toString()

This will return an xml list of all entries in the hashmap

Overrides:

toString in class java.util.AbstractMap

Returns:

the XML list of all entries in the hashmap