Package org.springframework.cloud.sleuth.instrument.async

Class TraceableExecutorService

java.lang.Object

org.springframework.cloud.sleuth.instrument.async.TraceableExecutorService

All Implemented Interfaces:

Executor, ExecutorService

Direct Known Subclasses:

TraceableScheduledExecutorService

public class TraceableExecutorService
extends Object
implements ExecutorService

A decorator class for ExecutorService to support tracing in Executors.

Since:

1.0.0

Author:

Gaurav Rai Mazra

Constructor Summary

Constructors

Constructor	Description
TraceableExecutorService(org.springframework.beans.factory.BeanFactory beanFactory, ExecutorService delegate)
TraceableExecutorService(org.springframework.beans.factory.BeanFactory beanFactory, ExecutorService delegate, String spanName)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)
void	execute(Runnable command)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)
static TraceableExecutorService	wrap(org.springframework.beans.factory.BeanFactory beanFactory, ExecutorService delegate)	Wraps the Executor in a trace instance.
static TraceableExecutorService	wrap(org.springframework.beans.factory.BeanFactory beanFactory, ExecutorService delegate, String beanName)	Wraps the Executor in a trace instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceableExecutorService

public TraceableExecutorService(org.springframework.beans.factory.BeanFactory beanFactory,
                                ExecutorService delegate)

TraceableExecutorService

public TraceableExecutorService(org.springframework.beans.factory.BeanFactory beanFactory,
                                ExecutorService delegate,
                                String spanName)

Method Detail

wrap

public static TraceableExecutorService wrap(org.springframework.beans.factory.BeanFactory beanFactory,
                                            ExecutorService delegate,
                                            String beanName)

Wraps the Executor in a trace instance.

Parameters:

beanFactory - bean factory

delegate - delegate to wrap

beanName - bean name

Returns:

traced instance

wrap

public static TraceableExecutorService wrap(org.springframework.beans.factory.BeanFactory beanFactory,
                                            ExecutorService delegate)

Wraps the Executor in a trace instance.

Parameters:

beanFactory - bean factory

delegate - delegate to wrap

Returns:

traced instance

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

shutdown

public void shutdown()

Specified by:

shutdown in interface ExecutorService

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException

submit

public <T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

submit

public <T> Future<T> submit(Runnable task,
                            T result)

Specified by:

submit in interface ExecutorService

submit

public Future<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
                                     long timeout,
                                     TimeUnit unit)
                              throws InterruptedException

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                throws InterruptedException,
                       ExecutionException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks,
                       long timeout,
                       TimeUnit unit)
                throws InterruptedException,
                       ExecutionException,
                       TimeoutException

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

TimeoutException