Class AsyncAnnotationBeanPostProcessor
- All Implemented Interfaces:
Serializable
,AopInfrastructureBean
,Aware
,BeanClassLoaderAware
,BeanFactoryAware
,BeanPostProcessor
,Ordered
Async
annotation at class or
method-level by adding a corresponding AsyncAnnotationAdvisor
to the
exposed proxy (either an existing AOP proxy or a newly generated proxy that
implements all of the target's interfaces).
The TaskExecutor
responsible for the asynchronous execution may
be provided as well as the annotation type that indicates a method should be
invoked asynchronously. If no annotation type is specified, this post-
processor will detect both Spring's @Async
annotation as well
as the EJB 3.1 jakarta.ejb.Asynchronous
annotation.
For methods having a void
return type, any exception thrown
during the asynchronous method invocation cannot be accessed by the
caller. An AsyncUncaughtExceptionHandler
can be specified to handle
these cases.
Note: The underlying async advisor applies before existing advisors by default, in order to switch to async execution as early as possible in the invocation chain.
- Since:
- 3.0
- Author:
- Mark Fisher, Juergen Hoeller, Stephane Nicoll
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The default name of theTaskExecutor
bean to pick up: "taskExecutor".protected final Log
Fields inherited from class org.springframework.aop.framework.AbstractAdvisingBeanPostProcessor
advisor, beforeExistingAdvisors
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this post-processor with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.void
setAsyncAnnotationType
(Class<? extends Annotation> asyncAnnotationType) Set the 'async' annotation type to be detected at either class or method level.void
setBeanFactory
(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.void
setExceptionHandler
(AsyncUncaughtExceptionHandler exceptionHandler) Set theAsyncUncaughtExceptionHandler
to use to handle uncaught exceptions thrown by asynchronous method executions.void
setExecutor
(Executor executor) Set theExecutor
to use when invoking methods asynchronously.Methods inherited from class org.springframework.aop.framework.autoproxy.AbstractBeanFactoryAwareAdvisingPostProcessor
isEligible, prepareProxyFactory
Methods inherited from class org.springframework.aop.framework.AbstractAdvisingBeanPostProcessor
customizeProxyFactory, isEligible, postProcessAfterInitialization, postProcessBeforeInitialization, setBeforeExistingAdvisors
Methods inherited from class org.springframework.aop.framework.ProxyProcessorSupport
evaluateProxyInterfaces, getOrder, getProxyClassLoader, isConfigurationCallbackInterface, isInternalLanguageInterface, setBeanClassLoader, setOrder, setProxyClassLoader
Methods inherited from class org.springframework.aop.framework.ProxyConfig
copyFrom, isExposeProxy, isFrozen, isOpaque, isOptimize, isProxyTargetClass, setExposeProxy, setFrozen, setOpaque, setOptimize, setProxyTargetClass, toString
-
Field Details
-
DEFAULT_TASK_EXECUTOR_BEAN_NAME
The default name of theTaskExecutor
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
- See Also:
-
logger
-
-
Constructor Details
-
AsyncAnnotationBeanPostProcessor
public AsyncAnnotationBeanPostProcessor()
-
-
Method Details
-
configure
public void configure(@Nullable Supplier<Executor> executor, @Nullable Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Configure this post-processor with the given executor and exception handler suppliers, applying the corresponding default if a supplier is not resolvable.- Since:
- 5.1
-
setExecutor
Set theExecutor
to use when invoking methods asynchronously.If not specified, default executor resolution will apply: searching for a unique
TaskExecutor
bean in the context, or for anExecutor
bean named "taskExecutor" otherwise. If neither of the two is resolvable, a local default executor will be created within the interceptor. -
setExceptionHandler
Set theAsyncUncaughtExceptionHandler
to use to handle uncaught exceptions thrown by asynchronous method executions.- Since:
- 4.1
-
setAsyncAnnotationType
Set the 'async' annotation type to be detected at either class or method level. By default, both theAsync
annotation and the EJB 3.1jakarta.ejb.Asynchronous
annotation will be detected.This setter property exists so that developers can provide their own (non-Spring-specific) annotation type to indicate that a method (or all methods of a given class) should be invoked asynchronously.
- Parameters:
asyncAnnotationType
- the desired annotation type
-
setBeanFactory
Description copied from interface:BeanFactoryAware
Callback that supplies the owning factory to a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean.afterPropertiesSet()
or a custom init-method.- Specified by:
setBeanFactory
in interfaceBeanFactoryAware
- Overrides:
setBeanFactory
in classAbstractBeanFactoryAwareAdvisingPostProcessor
- Parameters:
beanFactory
- owning BeanFactory (nevernull
). The bean can immediately call methods on the factory.- See Also:
-