Spring AOP 6.1.4 · org.springframework.aop.interceptor.AsyncExecutionAspectSupport

Modifier and Type	Field and Description
private BeanFactory	beanFactory
public static final String	DEFAULT_TASK_EXECUTOR_BEAN_NAME The default name of the `TaskExecutor` bean to pick up: "taskExecutor".
private SingletonSupplier<Executor>	defaultExecutor
private StringValueResolver	embeddedValueResolver
private SingletonSupplier<AsyncUncaughtExceptionHandler>	exceptionHandler
private final Map<Method, AsyncTaskExecutor>	executors
protected final Log	logger

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	AsyncExecutionAspectSupport(Executor the `Executor` (typically a Spring `AsyncTaskExecutor` or `java.util.concurrent.ExecutorService`) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory defaultExecutor) Create a new instance with a default `AsyncUncaughtExceptionHandler`.
public	AsyncExecutionAspectSupport(Executor the `Executor` (typically a Spring `AsyncTaskExecutor` or `java.util.concurrent.ExecutorService`) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory defaultExecutor, AsyncUncaughtExceptionHandler the `AsyncUncaughtExceptionHandler` to use exceptionHandler) Create a new `AsyncExecutionAspectSupport` with the given exception handler.

public

the Executor (typically a Spring AsyncTaskExecutor or java.util.concurrent.ExecutorService) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory

defaultExecutor)

Create a new instance with a default AsyncUncaughtExceptionHandler.

public

AsyncExecutionAspectSupport(Executor

defaultExecutor, AsyncUncaughtExceptionHandler

the AsyncUncaughtExceptionHandler to use

exceptionHandler)

Create a new AsyncExecutionAspectSupport with the given exception handler.

Method Summary

Modifier and Type	Method and Description
public void	configure(Supplier<Executor> defaultExecutor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this aspect with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.
protected AsyncTaskExecutor	Returns: the executor to use (or `null`, but just if no default executor is available) determineAsyncExecutor(Method method) Determine the specific executor to use when executing the given method.
protected Object	Returns: the execution result (potentially a corresponding `Future` handle) doSubmit(Callable<Object> the task to execute task, AsyncTaskExecutor the chosen executor executor, Class<?> the declared return type (potentially a `Future` variant) returnType) Delegate for actually executing the given task with the chosen executor.
protected Executor	Returns: the target executor, or `null` if none available findQualifiedExecutor(BeanFactory beanFactory, String the qualifier to resolve qualifier) Retrieve a target executor for the given qualifier.
protected Executor	Returns: the default executor, or `null` if none available getDefaultExecutor(BeanFactory the BeanFactory to use for a default executor lookup beanFactory) Retrieve or build a default executor for this advice instance.
protected abstract String	Returns: the qualifier if specified, otherwise empty String or `null` getExecutorQualifier(Method the method to inspect for executor qualifier metadata method) Return the qualifier or bean name of the executor to be used when executing the given async method, typically specified in the form of an annotation attribute.
protected void	handleError(Throwable the exception to handle ex, Method the method that was invoked method, Object... the parameters used to invoke the method params) Handles a fatal error thrown while asynchronously invoking the specified `Method`.
public void	setBeanFactory(BeanFactory owning BeanFactory (never `null`). The bean can immediately call methods on the factory. beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. Set the `BeanFactory` to be used when looking up executors by qualifier or when relying on the default executor lookup algorithm.
public void	setExceptionHandler(AsyncUncaughtExceptionHandler exceptionHandler) Supply the `AsyncUncaughtExceptionHandler` to use to handle exceptions thrown by invoking asynchronous methods with a `void` return type.
public void	setExecutor(Executor the `Executor` (typically a Spring `AsyncTaskExecutor` or `java.util.concurrent.ExecutorService`) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory defaultExecutor) Supply the executor to be used when executing async methods.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

beanFactory	back to summary
private BeanFactory beanFactory Annotations @Nullable

DEFAULT_TASK_EXECUTOR_BEAN_NAME back to summary

DEFAULT_TASK_EXECUTOR_BEAN_NAME	back to summary
public static final String DEFAULT_TASK_EXECUTOR_BEAN_NAME The default name of the `TaskExecutor` bean to pick up: "taskExecutor". Note that the initial lookup happens by type; this is just the fallback in case of multiple executor beans found in the context. Since 4.2.6

public static final String DEFAULT_TASK_EXECUTOR_BEAN_NAME

The default name of the TaskExecutor bean to pick up: "taskExecutor".

Note that the initial lookup happens by type; this is just the fallback in case of multiple executor beans found in the context.

Since: 4.2.6

defaultExecutor	back to summary
private SingletonSupplier<Executor> defaultExecutor

embeddedValueResolver	back to summary
private StringValueResolver embeddedValueResolver Annotations @Nullable

exceptionHandler	back to summary
private SingletonSupplier<AsyncUncaughtExceptionHandler> exceptionHandler

executors	back to summary
private final Map<Method, AsyncTaskExecutor> executors

logger	back to summary
protected final Log logger

Constructor Detail

AsyncExecutionAspectSupport back to summary

AsyncExecutionAspectSupport	back to summary
public AsyncExecutionAspectSupport(Executor defaultExecutor) Create a new instance with a default `AsyncUncaughtExceptionHandler`. Parameters defaultExecutor:Executor the `Executor` (typically a Spring `AsyncTaskExecutor` or `java.util.concurrent.ExecutorService`) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory

public AsyncExecutionAspectSupport(Executor defaultExecutor)

Create a new instance with a default AsyncUncaughtExceptionHandler.

Parameters

defaultExecutor:Executor: the Executor (typically a Spring AsyncTaskExecutor or java.util.concurrent.ExecutorService) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory

AsyncExecutionAspectSupport back to summary

AsyncExecutionAspectSupport	back to summary
public AsyncExecutionAspectSupport(Executor defaultExecutor, AsyncUncaughtExceptionHandler exceptionHandler) Create a new `AsyncExecutionAspectSupport` with the given exception handler. Parameters defaultExecutor:Executor the `Executor` (typically a Spring `AsyncTaskExecutor` or `java.util.concurrent.ExecutorService`) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory exceptionHandler:AsyncUncaughtExceptionHandler the `AsyncUncaughtExceptionHandler` to use

public AsyncExecutionAspectSupport(Executor defaultExecutor, AsyncUncaughtExceptionHandler exceptionHandler)

Create a new AsyncExecutionAspectSupport with the given exception handler.

Parameters

defaultExecutor:Executor: the Executor (typically a Spring AsyncTaskExecutor or java.util.concurrent.ExecutorService) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory
exceptionHandler:AsyncUncaughtExceptionHandler: the AsyncUncaughtExceptionHandler to use

Method Detail

configure	back to summary
public void configure(Supplier<Executor> defaultExecutor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this aspect with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable. Since 5.1

configure

back to summary

public void configure(Supplier<Executor> defaultExecutor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)

Configure this aspect with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.

Since: 5.1

determineAsyncExecutor back to summary

determineAsyncExecutor	back to summary
protected AsyncTaskExecutor determineAsyncExecutor(Method method) Determine the specific executor to use when executing the given method. Returns:AsyncTaskExecutor the executor to use (or `null`, but just if no default executor is available) Annotations @Nullable

protected AsyncTaskExecutor determineAsyncExecutor(Method method)

Determine the specific executor to use when executing the given method.

Returns:AsyncTaskExecutor

the executor to use (or null, but just if no default executor is available)

Annotations

@Nullable

doSubmit back to summary

doSubmit	back to summary
protected Object doSubmit(Callable<Object> task, AsyncTaskExecutor executor, Class<?> returnType) Delegate for actually executing the given task with the chosen executor. Parameters task:Callable<Object> the task to execute executor:AsyncTaskExecutor the chosen executor returnType:Class<?> the declared return type (potentially a `Future` variant) Returns:Object the execution result (potentially a corresponding `Future` handle) Annotations @Nullable @SuppressWarnings:deprecation

protected Object doSubmit(Callable<Object> task, AsyncTaskExecutor executor, Class<?> returnType)

Delegate for actually executing the given task with the chosen executor.

Parameters

task:Callable<Object>: the task to execute
executor:AsyncTaskExecutor: the chosen executor
returnType:Class<?>: the declared return type (potentially a Future variant)

Returns:Object

the execution result (potentially a corresponding Future handle)

Annotations

@Nullable
@SuppressWarnings:deprecation

findQualifiedExecutor back to summary

findQualifiedExecutor	back to summary
protected Executor findQualifiedExecutor(BeanFactory beanFactory, String qualifier) Retrieve a target executor for the given qualifier. Parameters qualifier:String the qualifier to resolve Returns:Executor the target executor, or `null` if none available Annotations @Nullable Since 4.2.6 See Also `getExecutorQualifier(Method)`

protected Executor findQualifiedExecutor(BeanFactory beanFactory, String qualifier)

Retrieve a target executor for the given qualifier.

Parameters

qualifier:String: the qualifier to resolve

Returns:Executor

the target executor, or null if none available

Annotations

@Nullable

Since

4.2.6

See Also

getExecutorQualifier(Method)

getDefaultExecutor back to summary

getDefaultExecutor	back to summary
protected Executor getDefaultExecutor(BeanFactory beanFactory) Retrieve or build a default executor for this advice instance. An executor returned from here will be cached for further use. The default implementation searches for a unique `TaskExecutor` bean in the context, or for an `Executor` bean named "taskExecutor" otherwise. If neither of the two is resolvable, this implementation will return `null`. Parameters beanFactory:BeanFactory the BeanFactory to use for a default executor lookup Returns:Executor the default executor, or `null` if none available Annotations @Nullable Since 4.2.6 See Also `findQualifiedExecutor(BeanFactory, String)`, `DEFAULT_TASK_EXECUTOR_BEAN_NAME`

protected Executor getDefaultExecutor(BeanFactory beanFactory)

Retrieve or build a default executor for this advice instance.

An executor returned from here will be cached for further use.

The default implementation searches for a unique TaskExecutor bean in the context, or for an Executor bean named "taskExecutor" otherwise. If neither of the two is resolvable, this implementation will return null.

Parameters

beanFactory:BeanFactory: the BeanFactory to use for a default executor lookup

Returns:Executor

the default executor, or null if none available

Annotations

@Nullable

Since

4.2.6

getExecutorQualifier back to summary

getExecutorQualifier	back to summary
protected abstract String getExecutorQualifier(Method method) Return the qualifier or bean name of the executor to be used when executing the given async method, typically specified in the form of an annotation attribute. Returning an empty string or `null` indicates that no specific executor has been specified and that the default executor should be used. Parameters method:Method the method to inspect for executor qualifier metadata Returns:String the qualifier if specified, otherwise empty String or `null` Annotations @Nullable See Also `determineAsyncExecutor(Method)`, `findQualifiedExecutor(BeanFactory, String)`

protected abstract String getExecutorQualifier(Method method)

Return the qualifier or bean name of the executor to be used when executing the given async method, typically specified in the form of an annotation attribute.

Returning an empty string or null indicates that no specific executor has been specified and that the default executor should be used.

Parameters

method:Method: the method to inspect for executor qualifier metadata

Returns:String

the qualifier if specified, otherwise empty String or null

Annotations

@Nullable

handleError back to summary

handleError	back to summary
protected void handleError(Throwable ex, Method method, Object... params) throws Exception Handles a fatal error thrown while asynchronously invoking the specified `Method`. If the return type of the method is a `Future` object, the original exception can be propagated by just throwing it at the higher level. However, for all other cases, the exception will not be transmitted back to the client. In that later case, the current `AsyncUncaughtExceptionHandler` will be used to manage such exception. Parameters ex:Throwable the exception to handle method:Method the method that was invoked params:Object[] the parameters used to invoke the method

protected void handleError(Throwable ex, Method method, Object... params) throws Exception

Handles a fatal error thrown while asynchronously invoking the specified Method.

If the return type of the method is a Future object, the original exception can be propagated by just throwing it at the higher level. However, for all other cases, the exception will not be transmitted back to the client. In that later case, the current AsyncUncaughtExceptionHandler will be used to manage such exception.

Parameters

ex:Throwable: the exception to handle
method:Method: the method that was invoked
params:Object[]: the parameters used to invoke the method

setBeanFactory back to summary

setBeanFactory	back to summary
public void setBeanFactory(BeanFactory beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. Set the `BeanFactory` to be used when looking up executors by qualifier or when relying on the default executor lookup algorithm. Parameters beanFactory:BeanFactory Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. owning BeanFactory (never `null`). The bean can immediately call methods on the factory. Annotations @Override See Also `findQualifiedExecutor(BeanFactory, String)`, `getDefaultExecutor(BeanFactory)`

public void setBeanFactory(BeanFactory beanFactory)

Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

Set the BeanFactory to be used when looking up executors by qualifier or when relying on the default executor lookup algorithm.

Parameters

beanFactory:BeanFactory

Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

owning BeanFactory (never null). The bean can immediately call methods on the factory.

Annotations

@Override

setExceptionHandler	back to summary
public void setExceptionHandler(AsyncUncaughtExceptionHandler exceptionHandler) Supply the `AsyncUncaughtExceptionHandler` to use to handle exceptions thrown by invoking asynchronous methods with a `void` return type.

setExecutor back to summary

setExecutor	back to summary
public void setExecutor(Executor defaultExecutor) Supply the executor to be used when executing async methods. Parameters defaultExecutor:Executor the `Executor` (typically a Spring `AsyncTaskExecutor` or `java.util.concurrent.ExecutorService`) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory See Also `getExecutorQualifier(Method)`, `setBeanFactory(BeanFactory)`, `getDefaultExecutor(BeanFactory)`

public void setExecutor(Executor defaultExecutor)

Supply the executor to be used when executing async methods.

Parameters

defaultExecutor:Executor: the Executor (typically a Spring AsyncTaskExecutor or java.util.concurrent.ExecutorService) to delegate to, unless a more specific executor has been requested via a qualifier on the async method, in which case the executor will be looked up at invocation time against the enclosing bean factory

public abstract Class AsyncExecutionAspectSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail