com.technia.tvc.core.util

Class SessionUtils

java.lang.Object

com.technia.tvc.core.util.SessionUtils

public class SessionUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static <T> T	getAttribute(javax.servlet.http.HttpSession session, java.lang.Class<? extends T> type) Returns the first attribute in the session of the specified type, or null if no such object is bound to the session.
static <T> T	getAttribute(javax.servlet.http.HttpSession session, java.lang.String name, java.lang.Class<? extends T> type) Returns the attribute with the specified name, but only if the value is an instance of the specified type.
static java.lang.String	getGeneratedKey(javax.servlet.http.HttpSession session) Generates a key, using the key generator stored within the session.
static java.lang.String	getString(javax.servlet.http.HttpSession session, java.lang.String key) Returns the value of the session stored String.
static java.lang.String	getString(javax.servlet.http.HttpSession session, java.lang.String key, java.lang.String defaultValue) Returns the value of the session stored String.
static void	invalidateSession(javax.servlet.http.HttpServletRequest request) Invalidates the session obtained from the request.
static java.lang.String	removeValue(javax.servlet.http.HttpSession session, java.lang.Object value) Removes a value from the session (without having to know what key it was bound with).
static boolean	setAttribute(javax.servlet.http.HttpSession session, java.lang.String name, java.lang.Object value) Sets the attribute with the specified value.

Methods inherited from class java.lang.Object

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

Method Detail

getGeneratedKey

public static java.lang.String getGeneratedKey(javax.servlet.http.HttpSession session)

Generates a key, using the key generator stored within the session. This method will use a sequential key generator that generates numbers with a length of 10 characters. This is a general purpose key generator, which can be used to generate numbers that are unique for one session.

Parameters:

session - The session.

Returns:

The generated key.

Since:

6.0.0

getAttribute

public static <T> T getAttribute(javax.servlet.http.HttpSession session,
                                 java.lang.Class<? extends T> type)

Returns the first attribute in the session of the specified type, or null if no such object is bound to the session.

Parameters:

session - The HTTP session

type - the required attribute type.

Since:

6.1.5

getAttribute

public static <T> T getAttribute(javax.servlet.http.HttpSession session,
                                 java.lang.String name,
                                 java.lang.Class<? extends T> type)

Returns the attribute with the specified name, but only if the value is an instance of the specified type.

Parameters:

session - The HTTP session

name - the name of the attribute.

type - the required attribute type.

setAttribute

public static boolean setAttribute(javax.servlet.http.HttpSession session,
                                   java.lang.String name,
                                   java.lang.Object value)

Sets the attribute with the specified value. If the value is null the attribute is removed.

Parameters:

session - the HTTP session.

name - the name of the attribute.

value - the value.

getString

public static java.lang.String getString(javax.servlet.http.HttpSession session,
                                         java.lang.String key)

Returns the value of the session stored String.

Parameters:

session - The session

key - The key, which the string is bound to.

Returns:

A String (or null)

Since:

2010.3.0

getString

public static java.lang.String getString(javax.servlet.http.HttpSession session,
                                         java.lang.String key,
                                         java.lang.String defaultValue)

Returns the value of the session stored String.

Parameters:

session - The session

key - The key, which the string is bound to.

defaultValue - The fallback value to return

Returns:

A String (or null)

Since:

2010.3.0

invalidateSession

public static void invalidateSession(javax.servlet.http.HttpServletRequest request)

Invalidates the session obtained from the request.

Parameters:

request - The current request.

Since:

2012.1.0

removeValue

public static java.lang.String removeValue(javax.servlet.http.HttpSession session,
                                           java.lang.Object value)

Removes a value from the session (without having to know what key it was bound with). if the object was found, the key is returned. If the object was not found, null is returned.

Parameters:

session - The HttpSession

value - The value to be removed

Returns:

The key of the removed value.

Since:

2012.2.0