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

Interface ThreadContextExecutorService

All Superinterfaces:

Executor, ExecutorService

All Known Implementing Classes:

DefaultThreadContextExecutorService

public interface ThreadContextExecutorService
extends ExecutorService

Allows the execution of Runnable and Callable within a ThreadContext within a ExecutorService.

The ThreadContext properties will be automatically propagated to the asynchronous task (either Runnable or Callable) if the current Thread already contains a ThreadContext.

For example:

 final DefaultThreadContextExecutorService executor =
     DefaultThreadContextExecutorService.of(Executors.newCachedThreadPool());
 final Future<Try<Tenant>> tenant =
     executor.submit(
         // code that is executed within the ThreadContext created by DefaultThreadContextExecutorService
         TenantAccessor::tryGetCurrentTenant);
 
 

See Also:

• ThreadContextExecutors

Method Summary

Modifier and Type	Method	Description
void	execute(Runnable command, ThreadContext threadContext)	Attach a ThreadContext to the given command and execute it.
void	execute(Runnable command, ThreadContextExecutor threadContextExecutor)	Attach a ThreadContextExecutor to the given command and execute it.
Future<?>	submit(Runnable task, ThreadContext threadContext)	Attach a ThreadContext to the given task and execute it.
Future<?>	submit(Runnable task, ThreadContextExecutor threadContextExecutor)	Attach a ThreadContextExecutor to the given task and execute it.
<T> Future<T>	submit(Runnable task, T result, ThreadContext threadContext)	Attach a ThreadContext to the given task and execute it.
<T> Future<T>	submit(Runnable task, T result, ThreadContextExecutor threadContextExecutor)	Attach a ThreadContextExecutor to the given task and execute it.
<T> Future<T>	submit(Callable<T> task, ThreadContext threadContext)	Attach a ThreadContext to the given task and execute it.
<T> Future<T>	submit(Callable<T> task, ThreadContextExecutor threadContextExecutor)	Attach a ThreadContextExecutor to the given task and execute it.

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit

Method Details

execute

void execute(@Nonnull
 Runnable command,
 @Nonnull
 ThreadContext threadContext)

Attach a ThreadContext to the given command and execute it.

Parameters:

command - the runnable task

threadContext - the ThreadContext to attach to the command

See Also:

• Executor.execute(Runnable)

execute

void execute(@Nonnull
 Runnable command,
 @Nonnull
 ThreadContextExecutor threadContextExecutor)

Attach a ThreadContextExecutor to the given command and execute it.

Parameters:

command - the runnable task

threadContextExecutor - the ThreadContextExecutor to attach to the command

See Also:

• Executor.execute(Runnable)

submit

@Nonnull
<T> Future<T> submit(@Nonnull
 Callable<T> task,
 @Nonnull
 ThreadContext threadContext)

Attach a ThreadContext to the given task and execute it.

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

threadContext - the ThreadContext to attach to the task

Returns:

a Future representing pending completion of the task

See Also:

• ExecutorService.submit(Callable)

submit

@Nonnull
<T> Future<T> submit(@Nonnull
 Callable<T> task,
 @Nonnull
 ThreadContextExecutor threadContextExecutor)

Attach a ThreadContextExecutor to the given task and execute it.

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

threadContextExecutor - the ThreadContextExecutor to attach to the task

Returns:

a Future representing pending completion of the task

See Also:

• ExecutorService.submit(Callable)

submit

@Nonnull
<T> Future<T> submit(@Nonnull
 Runnable task,
 @Nonnull
 T result,
 @Nonnull
 ThreadContext threadContext)

Attach a ThreadContext to the given task and execute it.

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

threadContext - the ThreadContext to attach to the task

result - the result to return

Returns:

a Future representing pending completion of the task

See Also:

• ExecutorService.submit(Runnable, Object)

submit

@Nonnull
<T> Future<T> submit(@Nonnull
 Runnable task,
 @Nonnull
 T result,
 @Nonnull
 ThreadContextExecutor threadContextExecutor)

Attach a ThreadContextExecutor to the given task and execute it.

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

threadContextExecutor - the ThreadContextExecutor to attach to the task

result - the result to return

Returns:

a Future representing pending completion of the task

See Also:

• ExecutorService.submit(Runnable, Object)

submit

@Nonnull
Future<?> submit(@Nonnull
 Runnable task,
 @Nonnull
 ThreadContext threadContext)

Attach a ThreadContext to the given task and execute it.

Parameters:

task - the task to submit

threadContext - the ThreadContext to attach to the task

Returns:

a Future representing pending completion of the task

See Also:

• ExecutorService.submit(Runnable)

submit

@Nonnull
Future<?> submit(@Nonnull
 Runnable task,
 @Nonnull
 ThreadContextExecutor threadContextExecutor)

Attach a ThreadContextExecutor to the given task and execute it.

Parameters:

task - the task to submit

threadContextExecutor - the ThreadContextExecutor to attach to the task

Returns:

a Future representing pending completion of the task

See Also:

• ExecutorService.submit(Runnable)