Package com.thingworx.webservices.context

Class ThreadLocalContext

java.lang.Object

com.thingworx.webservices.context.ThreadLocalContext

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class ThreadLocalContext
extends Object

A container for all session-managed objects.

The ThreadLocalContext class contains all objects that are tied to a request. This includes but is not limited to the session data, the authorized account that made the request, the transaction success state, events that have been queued for processing, and the entity (if any) the current request is being made against.

Security contexts are managed in a stack-like manner. That is, the most recently set security context is returned by ThreadLocalContext#getSecurityContext() and clearing a security context will move the previously set security context to the top.

See Also:

• SecurityContext
• TransactionFactory

Constructor Summary

Constructors

Constructor	Description
ThreadLocalContext()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
static void	cleanupContext()
static void	clearQueuedEvents()	Removes all queued events (if any) for the current thread.
static void	clearQueuedPostCommitEvents()
static SecurityContext	clearSecurityContext()
static void	dispatchQueuedEvents()	Dispatches the events queued for the current thread.
static String	getClientIP()
static Object	getMeContext()
static SecurityContext	getSecurityContext()
static jakarta.servlet.http.HttpSession	getSession()
String	getSessionId()
static Boolean	getTransactionSuccessStatus()
static Boolean	isImportActive()
static Boolean	isTraceActive()
static void	queueEvent(ThingworxEvent event)	Queues an event into the event queue for the current thread.
static void	queuePostCommitEvent(ThingworxEvent event)
static void	setSecurityContext(SecurityContext value)
static void	setSession(jakarta.servlet.http.HttpSession value)
static void	setTransactionSuccess(boolean status)

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadLocalContext

public ThreadLocalContext()

Initializes this instace with default values.

Method Details

getSecurityContext

@ThingworxExtensionApiMethod(since={6,6})
public static SecurityContext getSecurityContext()

Returns:

The security context.

setSecurityContext

@ThingworxExtensionApiMethod(since={6,6})
public static void setSecurityContext(SecurityContext value)

clearSecurityContext

@ThingworxExtensionApiMethod(since={6,6})
public static SecurityContext clearSecurityContext()

isTraceActive

@ThingworxExtensionApiMethod(since={6,6})
public static Boolean isTraceActive()

getMeContext

@ThingworxExtensionApiMethod(since={6,6})
public static Object getMeContext()

Returns:

isImportActive

@ThingworxExtensionApiMethod(since={6,6})
public static Boolean isImportActive()

setSession

@ThingworxExtensionApiMethod(since={6,6})
public static void setSession(jakarta.servlet.http.HttpSession value)

getSession

@ThingworxExtensionApiMethod(since={6,6})
public static jakarta.servlet.http.HttpSession getSession()

getSessionId

@ThingworxExtensionApiMethod(since={6,6})
public String getSessionId()

getClientIP

@ThingworxExtensionApiMethod(since={6,6})
public static String getClientIP()

queueEvent

@ThingworxExtensionApiMethod(since={7,0,1})
public static void queueEvent(ThingworxEvent event)

Queues an event into the event queue for the current thread. This can be used to support transactional event dispatch along with the dispatchQueuedEvents() and clearQueuedEvents() methods.

Parameters:

event - the event to add to the dispatch queue

queuePostCommitEvent

@ThingworxExtensionApiMethod(since={9,0})
public static void queuePostCommitEvent(ThingworxEvent event)

dispatchQueuedEvents

@ThingworxExtensionApiMethod(since={6,6})
public static void dispatchQueuedEvents()
                                 throws Exception

Dispatches the events queued for the current thread. The event queue will be empty after this method completes.

Throws:

Exception - if an exception occurred during event dispatch

clearQueuedEvents

@ThingworxExtensionApiMethod(since={7,0,1})
public static void clearQueuedEvents()

Removes all queued events (if any) for the current thread. The events are not dispatched.

clearQueuedPostCommitEvents

@ThingworxExtensionApiMethod(since={9,0})
public static void clearQueuedPostCommitEvents()

setTransactionSuccess

@ThingworxExtensionApiMethod(since={6,6})
public static void setTransactionSuccess(boolean status)

getTransactionSuccessStatus

@ThingworxExtensionApiMethod(since={6,6})
public static Boolean getTransactionSuccessStatus()

cleanupContext

@ThingworxExtensionApiMethod(since={6,6})
public static void cleanupContext()