ThreadContext ( @enterprise 10.0 API)

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

Fields
Modifier and Type	Field and Description
`static short`	`HTTP_SESSION` session types
`static short`	`INTERNAL_SESSION`
`protected static org.slf4j.Logger`	`logger`
`static short`	`REST_SESSION`
`static short`	`RMI_SESSION`
`static short`	`WEBDAV_SESSION`
`static short`	`WEBSERVICE_SESSION`
`static short`	`WOPI_SESSION`

Constructor Summary

Constructors
Constructor and Description

ThreadContext()

Constructors
Constructor and Description
`ThreadContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 principal, the user who performs the action.
`static HttpServletRequest`	`getThreadRequest()` Get the HttpServletRequest of this thread.
`static TimeZone`	`getThreadTimeZone()` Get the thread TimeZone
`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.
`static AutoCloseable`	`switchThreadLocale(Locale locale)` Change the locale of the thread.
`static AutoCloseable`	`switchThreadPrincipal(Principal p)` Change the principal of the thread.
`static AutoCloseable`	`switchThreadTimeZone(TimeZone tz)` Change 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
  - logger
```
protected static final org.slf4j.Logger logger
```
  - 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
  - WOPI_SESSION
```
public static final short WOPI_SESSION
```
    See Also:
    
    Constant Field Values
  - REST_SESSION
```
public static final short REST_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
  - switchThreadPrincipal
```
public static AutoCloseable switchThreadPrincipal(Principal p)
```
    Change the principal of the thread.
    Parameters:
    
    p - a Principal object
    
    Returns:
    AutoCloseable may be used in combination with a try-with-resources statement
    try(AutoCloseable closable = switchThreadPrincipal(Principal)) { ... }
  - switchThreadLocale
```
public static AutoCloseable switchThreadLocale(Locale locale)
```
    Change the locale of the thread.
    Parameters:
    
    locale - a Locale object
    
    Returns:
    AutoCloseable may be used in combination with a try-with-resources statement
    try(AutoCloseable closable = switchThreadLocale(Locale)) { ... }
  - switchThreadTimeZone
```
public static AutoCloseable switchThreadTimeZone(TimeZone tz)
```
    Change the timezone of the thread.
    Parameters:
    
    tz - a TimeZone object
    
    Returns:
    AutoCloseable may be used in combination with a try-with-resources statement
    try(AutoCloseable closable = switchThreadTimeZone(TimeZone)) { ... }
  - getThreadPrincipal
```
public static <T extends Principal> T getThreadPrincipal()
```
    Get the thread principal, 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.
  - addThreadLocale
```
public static void addThreadLocale(ThreadLocal<?> local)
```

Class ThreadContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

HTTP_SESSION

RMI_SESSION

INTERNAL_SESSION

WEBDAV_SESSION

WEBSERVICE_SESSION

WOPI_SESSION

REST_SESSION

Constructor Detail

ThreadContext

Method Detail

setThreadLocale

getThreadLocale

setThreadPrincipal

switchThreadPrincipal

switchThreadLocale

switchThreadTimeZone

getThreadPrincipal

setSessionId

getSessionId

setThreadTimeZone

getThreadTimeZone

getSessions

setPrivileged

isPrivileged

setThreadRequest

getThreadRequest

getSessionType

setSessionType

setAttribute

getAttribute

removeAttribute

getAttributeKeys

clean

addThreadLocale