org.eclipse.dirigible.commons.api.context

Class ThreadContextFacade

java.lang.Object

org.eclipse.dirigible.commons.api.context.ThreadContextFacade

public class ThreadContextFacade
extends Object

Scripting context facade is the centralized place where the different scripting facade providers can register the request (sync) scoped objects.

Constructor Summary

Constructors

Constructor and Description
ThreadContextFacade()

Method Summary

Modifier and Type	Method and Description
static Object	get(String key) Get a context scripting object.
static Object	getProxy(String key) Get a proxy scripting object.
static boolean	isValid() Check whether the facade is valid.
static void	remove(String key) Remove a context scripting object.
static void	removeProxy(String key) Remove a proxy scripting object.
static String	set(Object value) Set a context scripting object.
static void	set(String key, Object value) Set a context scripting object.
static String	setProxy(Object value) Set a proxy scripting object.
static void	setProxy(String key, Object value) Set a proxy scripting object.
static void	setUp() Initializes the context.
static void	tearDown() IMPORTANT! This have to be added at the finally block to clean up objects after the execution of the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadContextFacade

public ThreadContextFacade()

Method Detail

setUp

public static final void setUp()
                        throws ContextException

Initializes the context. This has to be called at the very first (as possible) place at the service entry point

Throws:

ContextException - in case of an error

tearDown

public static final void tearDown()
                           throws ContextException

IMPORTANT! This have to be added at the finally block to clean up objects after the execution of the service.

Throws:

ContextException - in case of an error

get

public static final Object get(String key)
                        throws ContextException

Get a context scripting object.

Parameters:

key - the key

Returns:

the value by this key

Throws:

ContextException - in case of an error

set

public static final String set(Object value)
                        throws ContextException

Set a context scripting object.

Parameters:

value - the value

Returns:

the UUID of the object

Throws:

ContextException - in case of an error

set

public static final void set(String key,
                             Object value)
                      throws ContextException

Set a context scripting object. If object with with this key exists, it will be replaced with the new object

Parameters:

key - the key

value - the value

Throws:

ContextException - in case of an error

remove

public static final void remove(String key)
                         throws ContextException

Remove a context scripting object.

Parameters:

key - the key

Throws:

ContextException - in case of an error

isValid

public static boolean isValid()

Check whether the facade is valid.

Returns:

yes, if it is valid

getProxy

public static final Object getProxy(String key)
                             throws ContextException

Get a proxy scripting object.

Parameters:

key - the key

Returns:

the value by this key

Throws:

ContextException - in case of an error

setProxy

public static final String setProxy(Object value)
                             throws ContextException

Set a proxy scripting object.

Parameters:

value - the value

Returns:

the UUID of the object

Throws:

ContextException - in case of an error

setProxy

public static final void setProxy(String key,
                                  Object value)
                           throws ContextException

Set a proxy scripting object. If proxy object with this key exists, it will be replaced with the new object

Parameters:

key - the key

value - the value

Throws:

ContextException - in case of an error

removeProxy

public static final void removeProxy(String key)
                              throws ContextException

Remove a proxy scripting object.

Parameters:

key - the key

Throws:

ContextException - in case of an error