org.fujion.client

Class ExecutionContext

java.lang.Object

org.fujion.client.ExecutionContext

public class ExecutionContext
extends Object

Static helper class for threads to determine the current execution context. An execution context is created each time a thread services a client request. It contains information about the target page and the session servicing the request, as well as the request itself.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_PROCESSING
static String	ATTR_REQUEST

Method Summary

Modifier and Type	Method and Description
static void	clear() Clears the thread-local map.
static void	destroy() Destroys the thread-local map.
static Object	get(String key) Returns the value associated with a key, or null if not found.
static Page	getPage() Returns the active client page.
static ClientRequest	getRequest() Returns the active client request.
static javax.servlet.ServletContext	getServletContext() Returns the servlet context.
static Session	getSession() Returns the active client session.
static void	invoke(String pid, Runnable callback) Invoke a callback in the execution context of the specified page.
static boolean	isEmpty() Returns true if the thread-local map is empty.
static boolean	isProcessing() Returns true if execution is processing a web socket request.
static Object	put(String key, Object value) Put a key/value pair in the thread-local map.
static Object	remove(String key) Removes a value given its key.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_REQUEST

public static final String ATTR_REQUEST

See Also:

Constant Field Values

ATTR_PROCESSING

public static final String ATTR_PROCESSING

See Also:

Constant Field Values

Method Detail

put

public static Object put(String key,
                         Object value)

Put a key/value pair in the thread-local map.

Parameters:

key - The key.

value - The value.

Returns:

The previous value.

get

public static Object get(String key)

Returns the value associated with a key, or null if not found.

Parameters:

key - The key.

Returns:

The associated value, or null if there is none.

remove

public static Object remove(String key)

Removes a value given its key.

Parameters:

key - The key.

Returns:

The value associated with the key, or null if none.

clear

public static void clear()

Clears the thread-local map.

destroy

public static void destroy()

Destroys the thread-local map.

isEmpty

public static boolean isEmpty()

Returns true if the thread-local map is empty.

Returns:

True if the thread-local map is empty.

isProcessing

public static boolean isProcessing()

Returns true if execution is processing a web socket request.

Returns:

True if execution is processing a web socket request.

getRequest

public static ClientRequest getRequest()

Returns the active client request.

Returns:

The active client request.

getSession

public static Session getSession()

Returns the active client session.

Returns:

The active client session.

getPage

public static Page getPage()

Returns the active client page.

Returns:

The active client page.

getServletContext

public static javax.servlet.ServletContext getServletContext()

Returns the servlet context.

Returns:

The servlet context.

invoke

public static void invoke(String pid,
                          Runnable callback)

Invoke a callback in the execution context of the specified page.

Parameters:

pid - The id of the page.

callback - The callback to invoke.