com.serotonin.mango.util

Class BackgroundContext

java.lang.Object

com.serotonin.mango.util.BackgroundContext

public class BackgroundContext
extends java.lang.Object

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.ThreadLocal<BackgroundContext>	contextStore The ThreadLocal instance that will contain the various BackgroundContext objects.
private java.lang.String	processDescriptionKey
private User	user

Constructor Summary

Constructors

Modifier	Constructor and Description
private	BackgroundContext(java.lang.String processDescriptionKey)
private	BackgroundContext(User user) Constructor

Method Summary

Modifier and Type	Method and Description
static BackgroundContext	get() Used within user code to access the context objects.
java.lang.String	getProcessDescriptionKey()
User	getUser()
static void	remove() Removes the BackgroundContext object from this thread once we are done with it.
static void	set(java.lang.String processDescriptionKey)
static void	set(User user) Creates the BackgroundContext instance for this thread and adds it to the store.

Methods inherited from class java.lang.Object

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

Field Detail

contextStore

private static java.lang.ThreadLocal<BackgroundContext> contextStore

The ThreadLocal instance that will contain the various BackgroundContext objects.

user

private final User user

processDescriptionKey

private final java.lang.String processDescriptionKey

Constructor Detail

BackgroundContext

private BackgroundContext(User user)

Constructor

BackgroundContext

private BackgroundContext(java.lang.String processDescriptionKey)

Method Detail

set

public static void set(User user)

Creates the BackgroundContext instance for this thread and adds it to the store.

set

public static void set(java.lang.String processDescriptionKey)

get

public static BackgroundContext get()

Used within user code to access the context objects.

Returns:

the BackgroundContext object found for this thread.

remove

public static void remove()

Removes the BackgroundContext object from this thread once we are done with it.

getUser

public User getUser()

getProcessDescriptionKey

public java.lang.String getProcessDescriptionKey()