freework.web.util

类 ThreadContext

java.lang.Object

freework.web.util.ThreadContext

public abstract class ThreadContext
extends Object

A ThreadContext provides a means of binding and unbinding objects to the current thread based on key/value pairs.

An internal HashMap is used to maintain the key/value pairs for each thread.

If the desired behavior is to ensure that bound data is not shared across threads in a pooled or reusable threaded environment, the application (or more likely a framework) must bind and remove any necessary values at the beginning and end of stack execution, respectively (i.e. individually explicitly or all via the clear method).

从以下版本开始:

0.1

另请参阅:

remove()

构造器概要

构造器

限定符	构造器和说明
protected	ThreadContext() Default no-argument constructor.

方法概要

限定符和类型	方法和说明
static Object	get(Object key) Returns the object for the specified key that is bound to the current thread.
static Map<Object,Object>	getResources() Returns the ThreadLocal Map.
static void	put(Object key, Object value) Binds value for the given key to the current thread.
static void	remove() Removes the underlying ThreadLocal from the thread.
static Object	remove(Object key) Unbinds the value for the given key from the current thread.
static void	setResources(Map<Object,Object> newResources) Allows a caller to explicitly set the entire resource map.

从类继承的方法 java.lang.Object

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

构造器详细资料

ThreadContext

protected ThreadContext()

Default no-argument constructor.

方法详细资料

getResources

public static Map<Object,Object> getResources()

Returns the ThreadLocal Map. This Map is used internally to bind objects to the current thread by storing each object under a unique key.

返回:

the map of bound resources

setResources

public static void setResources(Map<Object,Object> newResources)

Allows a caller to explicitly set the entire resource map. This operation overwrites everything that existed previously in the ThreadContext - if you need to retain what was on the thread prior to calling this method, call the getResources() method, which will give you the existing state.

参数:

newResources - the resources to replace the existing resources.

从以下版本开始:

1.0

get

public static Object get(Object key)

Returns the object for the specified key that is bound to the current thread.

参数:

key - the key that identifies the value to return

返回:

the object keyed by key or null if no value exists for the specified key

put

public static void put(Object key,
                       Object value)

Binds value for the given key to the current thread.

A null value has the same effect as if remove was called for the given key, i.e.:

 if ( value == null ) {
     remove( key );
 }

参数:

key - The key with which to identify the value.

value - The value to bind to the thread.

抛出:

IllegalArgumentException - if the key argument is null.

remove

public static Object remove(Object key)

Unbinds the value for the given key from the current thread.

参数:

key - The key identifying the value bound to the current thread.

返回:

the object unbound or null if there was mux bound under the specified key name.

remove

public static void remove()

Removes the underlying ThreadLocal from the thread.

This method is meant to be the final 'clean up' operation that is called at the end of thread execution to prevent thread corruption in pooled thread environments.

从以下版本开始:

1.0