com.sap.cloud.sdk.cloudplatform.thread

Class AbstractThreadContextExecutor<ExecutorT extends AbstractThreadContextExecutor<ExecutorT>>

java.lang.Object

com.sap.cloud.sdk.cloudplatform.thread.AbstractThreadContextExecutor<ExecutorT>

Type Parameters:

ExecutorT - The type of the implementation.

Direct Known Subclasses:

ThreadContextExecutor

public abstract class AbstractThreadContextExecutor<ExecutorT extends AbstractThreadContextExecutor<ExecutorT>>
extends Object

Abstract class providing methods to execute an arbitrary command in a ThreadContext.

The implementations can be called in a fluent way like:

 new Implementation().withListeners(...).execute(() -> System.out.println("Called inside a thread context."));
 

Constructor Summary

Constructors

Constructor and Description
AbstractThreadContextExecutor()

Method Summary

Modifier and Type	Method and Description
<T> T	execute(Callable<T> callable) Executes the given Callable as if it was called inside a ThreadContext.
void	execute(Executable executable) Executes the given Executable as if it was called inside a ThreadContext.
List<ThreadContextDecorator>	getDecoratorsOrderedByPriority() Returns ThreadContextDecorators by their priority.
List<ThreadContextListener>	getListenersOrderedByPriority() Returns ThreadContextListeners by their priority.
protected abstract ExecutorT	getThis() Getter needed to allow for a type safe return in the builder methods.
ExecutorT	withDecorators(Iterable<ThreadContextDecorator> decorators) Adds the specified decorators to the life-cycle of the ThreadContext.
ExecutorT	withDecorators(ThreadContextDecorator... decorators) Adds the specified decorators to the life-cycle of the ThreadContext.
ExecutorT	withListeners(Iterable<ThreadContextListener> listeners) Adds the specified listeners to the life-cycle of the ThreadContext.
ExecutorT	withListeners(ThreadContextListener... listeners) Adds the specified listeners to the life-cycle of the ThreadContext.
ExecutorT	withoutDecorators(Integer... decoratorPriorities) Removes the decorators with the given priorities from the life-cycle of the ThreadContext.
ExecutorT	withoutDecorators(Iterable<Integer> decoratorPriorities) Removes the decorators with the given priorities from the life-cycle of the ThreadContext.
ExecutorT	withoutDefaultDecorators() Removes all SDK-provided decorators on the classpath from the executor call.
ExecutorT	withoutDefaultListeners() Removes all SDK provided listeners on the classpath from the executor call.
ExecutorT	withoutListeners(Integer... listenerPriorities) Removes the listeners with the given priorities from the life-cycle of the ThreadContext.
ExecutorT	withoutListeners(Iterable<Integer> listenerPriorities) Removes the listeners with the given priorities from the life-cycle of the ThreadContext.
ExecutorT	withoutParentThreadContext() Specifies that no existing parent ThreadContext should be used by this executor.
ExecutorT	withThreadContext(ThreadContext threadContext) The given ThreadContext is used for the call made with the execute(Callable) or execute(Executable) methods.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractThreadContextExecutor

public AbstractThreadContextExecutor()

Method Detail

getThis

@Nonnull
protected abstract ExecutorT getThis()

Getter needed to allow for a type safe return in the builder methods. This method should be implemented as

 protected ImplementingType getThis()
 {
     return this;
 }
 

in the subclasses.

Returns:

The current instance of the implementation.

withThreadContext

@Nonnull
public ExecutorT withThreadContext(@Nonnull
                                            ThreadContext threadContext)

The given ThreadContext is used for the call made with the execute(Callable) or execute(Executable) methods. If this method is not invoked, the currently set ThreadContext is inherited, or if no context currently is set, a new ThreadContext is used.

Parameters:

threadContext - The thread context to be used by this executor.

Returns:

This executor to provide a fluent interface.

withoutParentThreadContext

@Nonnull
public ExecutorT withoutParentThreadContext()

Specifies that no existing parent ThreadContext should be used by this executor.

Returns:

This executor to provide a fluent interface.

withoutDefaultListeners

@Nonnull
public ExecutorT withoutDefaultListeners()

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

The various libraries of the SDK provide several different 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 executor to provide a fluent interface.

withListeners

@Nonnull
public ExecutorT 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 executor to provide a fluent interface.

withListeners

@Nonnull
public ExecutorT 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 executor to provide a fluent interface.

withoutListeners

@Nonnull
public ExecutorT 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 executor to provide a fluent interface.

withoutListeners

@Nonnull
public ExecutorT 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 executor to provide a fluent interface.

getListenersOrderedByPriority

@Nonnull
public List<ThreadContextListener> getListenersOrderedByPriority()

Returns ThreadContextListeners by their priority.

Returns:

The list of listeners.

withoutDefaultDecorators

@Nonnull
public ExecutorT withoutDefaultDecorators()

Removes all SDK-provided decorators on the classpath from the executor call.

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

Returns:

This executor to provide a fluent interface.

withDecorators

@Nonnull
public ExecutorT withDecorators(@Nonnull
                                         ThreadContextDecorator... decorators)

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

Parameters:

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

Returns:

This executor to provide a fluent interface.

withDecorators

@Nonnull
public ExecutorT withDecorators(@Nonnull
                                         Iterable<ThreadContextDecorator> decorators)

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

Parameters:

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

Returns:

This executor to provide a fluent interface.

withoutDecorators

@Nonnull
public ExecutorT withoutDecorators(@Nonnull
                                            Integer... decoratorPriorities)

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

Parameters:

decoratorPriorities - The priorities of the decorators to remove.

Returns:

This executor to provide a fluent interface.

withoutDecorators

@Nonnull
public ExecutorT withoutDecorators(@Nonnull
                                            Iterable<Integer> decoratorPriorities)

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

Parameters:

decoratorPriorities - The priorities of the decorators to remove.

Returns:

This executor to provide a fluent interface.

getDecoratorsOrderedByPriority

@Nonnull
public List<ThreadContextDecorator> getDecoratorsOrderedByPriority()

Returns ThreadContextDecorators by their priority.

Returns:

The list of decorators.

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.