Package com.sap.cloud.sdk.cloudplatform.thread

Class ThreadContextExecutor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.thread.ThreadContextExecutor

public final class ThreadContextExecutor
extends Object

Executes a Callable or Executable within a ThreadContext.

For example:

 ThreadContextExecutor.fromNewContext().execute(() -> {
     // code that is executed within the ThreadContext created by ThreadContextExecutor
     new MyODataService().getAllEntities().top(10).execute();
 });
 
 

Note: Please be aware that if you pass a ThreadContext to the executor, you have to make sure that this context is not destroyed during execution, for example, within asynchronous tasks. You should therefore only pass a ThreadContext for which you manage the lifecycle yourself.

Method Summary

Modifier and Type	Method	Description
void	execute(Executable executable)	Executes the given Executable as if it was called inside a ThreadContext.
<T> T	execute(Callable<T> callable)	Executes the given Callable as if it was called inside a ThreadContext.
static ThreadContextExecutor	fromCurrentContext()	Create a ThreadContextExecutor using the current ThreadContext, that is being resolved from ThreadContextAccessor and duplicated with all existing properties.
static ThreadContextExecutor	fromCurrentOrNewContext()	Create a ThreadContextExecutor using the current ThreadContext, if one is available.
static ThreadContextExecutor	fromNewContext()	Create a ThreadContextExecutor using a new instance of ThreadContext with empty properties.
<T extends ThreadContextListener> io.vavr.control.Option<T>	getListener(int listenerPriority)	Get a ThreadContextListener by its priority.
List<ThreadContextListener>	getListenersOrderedByPriority()	Returns ThreadContextListeners by their priority.
static ThreadContextExecutor	using(ThreadContext context)	Create a ThreadContextExecutor using a duplicate of the provided ThreadContext with preset properties.
ThreadContextExecutor	withListeners(ThreadContextListener... listeners)	Adds the specified listeners to the life-cycle of the ThreadContext.
ThreadContextExecutor	withListeners(Iterable<ThreadContextListener> listeners)	Adds the specified listeners to the life-cycle of the ThreadContext.
ThreadContextExecutor	withoutDefaultListeners()	Removes all SDK provided listeners on the classpath from the executor call.
ThreadContextExecutor	withoutListeners(Integer... listenerPriorities)	Removes the listeners with the given priorities from the life-cycle of the ThreadContext.
ThreadContextExecutor	withoutListeners(Iterable<Integer> listenerPriorities)	Removes the listeners with the given priorities from the life-cycle of the ThreadContext.

Methods inherited from class java.lang.Object

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

Method Details

fromCurrentContext

@Nonnull
public static ThreadContextExecutor fromCurrentContext()
                                                throws ThreadContextAccessException

Create a ThreadContextExecutor using the current ThreadContext, that is being resolved from ThreadContextAccessor and duplicated with all existing properties. If no ThreadContext can be determined, then an exception will be thrown.

Returns:

A new instance of ThreadContextExecutor.

Throws:

ThreadContextAccessException - if a ThreadContext cannot be resolved.

fromCurrentOrNewContext

@Nonnull
public static ThreadContextExecutor fromCurrentOrNewContext()

Create a ThreadContextExecutor using the current ThreadContext, if one is available. Otherwise, a new DefaultThreadContext is created.

Returns:

A new instance of ThreadContextExecutor.

Throws:

ThreadContextAccessException - if a ThreadContext cannot be resolved.

See Also:

• fromCurrentContext()
• fromNewContext()

fromNewContext

@Nonnull
public static ThreadContextExecutor fromNewContext()

Create a ThreadContextExecutor using a new instance of ThreadContext with empty properties.

Returns:

A new instance of ThreadContextExecutor.

using

@Nonnull
public static ThreadContextExecutor using(@Nonnull
 ThreadContext context)

Create a ThreadContextExecutor using a duplicate of the provided ThreadContext with preset properties.

Parameters:

context - An existing instance of ThreadContext.

Returns:

A new instance of ThreadContextExecutor.

withoutDefaultListeners

@Nonnull
public ThreadContextExecutor withoutDefaultListeners()

Removes all SDK provided listeners on the classpath from the executor call.

The various libraries of the SDK provide several implementations of the ThreadContextListener which are loaded automatically if their libraries are part of the classpath. To fine tune the used listeners this method allows to ignore those automatically loaded implementation.

Returns:

This ThreadContextExecutor to provide a fluent interface.

withListeners

@Nonnull
public ThreadContextExecutor withListeners(@Nonnull
 ThreadContextListener... listeners)

Adds the specified listeners to the life-cycle of the ThreadContext.

Parameters:

listeners - The listeners to use during creation and destruction of the ThreadContext.

Returns:

This ThreadContextExecutor to provide a fluent interface.

withListeners

@Nonnull
public ThreadContextExecutor withListeners(@Nonnull
 Iterable<ThreadContextListener> listeners)

Adds the specified listeners to the life-cycle of the ThreadContext.

Parameters:

listeners - The listeners to use during creation and destruction of the ThreadContext.

Returns:

This ThreadContextExecutor to provide a fluent interface.

withoutListeners

@Nonnull
public ThreadContextExecutor withoutListeners(@Nonnull
 Integer... listenerPriorities)

Removes the listeners with the given priorities from the life-cycle of the ThreadContext.

Parameters:

listenerPriorities - The priorities of the listeners to remove.

Returns:

This ThreadContextExecutor to provide a fluent interface.

withoutListeners

@Nonnull
public ThreadContextExecutor withoutListeners(@Nonnull
 Iterable<Integer> listenerPriorities)

Removes the listeners with the given priorities from the life-cycle of the ThreadContext.

Parameters:

listenerPriorities - The priorities of the listeners to remove.

Returns:

This ThreadContextExecutor to provide a fluent interface.

getListenersOrderedByPriority

@Nonnull
public List<ThreadContextListener> getListenersOrderedByPriority()

Returns ThreadContextListeners by their priority.

Returns:

The list of listeners.

getListener

@Nonnull
public <T extends ThreadContextListener>
io.vavr.control.Option<T> getListener(int listenerPriority)

Get a ThreadContextListener by its priority.

Type Parameters:

T - The type of listener

Parameters:

listenerPriority - The priority of the listeners.

Returns:

The expected listener, or null.

execute

@Nullable
public <T> T execute(@Nonnull
 Callable<T> callable)
              throws ThreadContextExecutionException

Executes the given Callable as if it was called inside a ThreadContext.

Type Parameters:

T - The return type of the given Callable.

Parameters:

callable - The Callable to execute inside a ThreadContext.

Returns:

The value computed by the specified Callable.

Throws:

ThreadContextExecutionException - If there is an issue while computing the value.

execute

public void execute(@Nonnull
 Executable executable)
             throws ThreadContextExecutionException

Executes the given Executable as if it was called inside a ThreadContext.

Parameters:

executable - The Executable to execute inside a ThreadContext.

Throws:

ThreadContextExecutionException - If there is an issue while running the Executable.