com.groiss.util
Class ThreadContext

java.lang.Object
  com.groiss.util.ThreadContext

public class ThreadContext
extends Object

This class is designed to hold thread specific information which can then be requested anywhere in the code.

Field Summary

static short	HTTP_SESSION session types
static short	INTERNAL_SESSION
static short	RMI_SESSION
static short	WEBDAV_SESSION
static short	WEBSERVICE_SESSION

Constructor Summary

ThreadContext()

Method Summary

static void	addThreadLocale(ThreadLocal<?> local)
static void	clean() Clean the thread context.
static Object	getAttribute(Object key) Gets the value identified by the passed key
Iterator<Object>	getAttributeKeys() Returns an iterator over all keys which were added via method setAttribute(Object, Object)
static String	getSessionId() Get the thread sessionId.
static ThreadLocal2<String>	getSessions() Get the sessions.
static short	getSessionType() Get the type of the Session
static Locale	getThreadLocale() Get the thread locale.
static <T extends Principal> T	getThreadPrincipal() Get the thread princiapl, the user who performs the action.
static HttpServletRequest	getThreadRequest() Get the HttpServletRequest of this thread.
static TimeZone	getThreadTimeZone() Get the thread TimeZone
static void	internalClean() Clean the thread context of internal sessions if configuration param is set to true
static boolean	isPrivileged() Is the thread privileged.
static void	removeAttribute(Object key) Removes the key-value pair identified by the passed key
static void	setAttribute(Object key, Object value) Adds a key-value pair to the thread's context.
static void	setPrivileged() Set the thread privileged.
static void	setSessionId(String s) Set the session id of the thread.
static void	setSessionType(short s) Set the type of this thread.
static void	setThreadLocale(Locale l) Set the locale of the thread.
static void	setThreadPrincipal(Principal p) Set the principal of the thread.
static void	setThreadRequest(HttpServletRequest req) Set the HttpServletRequest of the thread.
static void	setThreadTimeZone(TimeZone t) Set the TimeZone of the thread.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_SESSION

public static final short HTTP_SESSION

session types

See Also:

Constant Field Values

RMI_SESSION

public static final short RMI_SESSION

See Also:

Constant Field Values

INTERNAL_SESSION

public static final short INTERNAL_SESSION

See Also:

Constant Field Values

WEBDAV_SESSION

public static final short WEBDAV_SESSION

See Also:

Constant Field Values

WEBSERVICE_SESSION

public static final short WEBSERVICE_SESSION

See Also:

Constant Field Values

Constructor Detail

ThreadContext

public ThreadContext()

Method Detail

setThreadLocale

public static void setThreadLocale(Locale l)

Set the locale of the thread.

Parameters:

l - a locale object

getThreadLocale

public static Locale getThreadLocale()

Get the thread locale. If the thread has no locale set, the method returns the default locale.

Returns:

a Locale object

setThreadPrincipal

public static void setThreadPrincipal(Principal p)

Set the principal of the thread.

Parameters:

p - a Principal object

getThreadPrincipal

public static <T extends Principal> T getThreadPrincipal()

Get the thread princiapl, the user who performs the action.

Returns:

a Principal object

setSessionId

public static void setSessionId(String s)

Set the session id of the thread.

Parameters:

s - a string object

getSessionId

public static String getSessionId()

Get the thread sessionId.

Returns:

a String object

setThreadTimeZone

public static void setThreadTimeZone(TimeZone t)

Set the TimeZone of the thread.

Parameters:

t - a TimeZone object

getThreadTimeZone

public static TimeZone getThreadTimeZone()

Get the thread TimeZone

Returns:

a TimeZone object

getSessions

public static ThreadLocal2<String> getSessions()

Get the sessions.

Returns:

a ThreadLocal2 object

setPrivileged

public static void setPrivileged()

Set the thread privileged.

isPrivileged

public static boolean isPrivileged()

Is the thread privileged.

Returns:

true if user of this thread is sysadm

setThreadRequest

public static void setThreadRequest(HttpServletRequest req)

Set the HttpServletRequest of the thread.

Parameters:

req - a HttpServletRequest object

getThreadRequest

public static HttpServletRequest getThreadRequest()

Get the HttpServletRequest of this thread.

Returns:

a HttpServletRequest object

getSessionType

public static short getSessionType()

Get the type of the Session

Returns:

the Session type.

setSessionType

public static void setSessionType(short s)

Set the type of this thread.

Parameters:

s - either HTTP_SESSION, RMI_SESSION or INTERNAL_SESSION

setAttribute

public static void setAttribute(Object key,
                                Object value)

Adds a key-value pair to the thread's context. If the key is already contained, the old value is replaced.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

getAttribute

public static Object getAttribute(Object key)

Gets the value identified by the passed key

Parameters:

key - key whose value should be retrieved

Returns:

the value object

removeAttribute

public static void removeAttribute(Object key)

Removes the key-value pair identified by the passed key

Parameters:

key - key whose value should be removed

getAttributeKeys

public Iterator<Object> getAttributeKeys()

Returns an iterator over all keys which were added via method setAttribute(Object, Object)

Returns:

iterator containing the key objects

clean

public static void clean()

Clean the thread context.

internalClean

public static void internalClean()

Clean the thread context of internal sessions if configuration param is set to true

addThreadLocale

public static void addThreadLocale(ThreadLocal<?> local)