org.josef.web.jsf.util

Class JsfSessionUtil

java.lang.Object

org.josef.web.jsf.util.JsfSessionUtil

public final class JsfSessionUtil
extends Object

Java Server Faces Utility class related to session handling.

Version:

1.0 $Revision: 4103 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static Object	getObjectFromSession(String key) Gets an Object from the current session.
static Map<String,Object>	getSessionMap() Convenience method to get the session map.
static String	getStringFromSession(String key) Gets a String object from the current session.
static Object	putInSession(String key, Object object) Puts the supplied object, using the supplied key, in the session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSessionMap

public static Map<String,Object> getSessionMap()

Convenience method to get the session map.

Returns:

The session map.

getStringFromSession

public static String getStringFromSession(String key)

Gets a String object from the current session.

Parameters:

key - The key of the object to get.

Returns:

A String object from the current session or null when either the session has not been created yet or the session exists but it does not contain the supplied key.

getObjectFromSession

public static Object getObjectFromSession(String key)

Gets an Object from the current session.

Parameters:

key - The key of the object to get.

Returns:

An Object from the current session or null when either the session has not been created yet or the session exists but it does not contain the supplied key.

putInSession

public static Object putInSession(String key,
                                  Object object)

Puts the supplied object, using the supplied key, in the session.

Parameters:

key - The key to store the supplied object under.

object - The object to store in the session.

Returns:

The previous object that was stored in the session with the supplied key or null when no previous object was stored in the session with the supplied key.

Throws:

NullPointerException - When the supplied key is null.

IllegalArgumentException - When the supplied key is empty.