public class AsyncAnnotationBeanPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessor
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 javax.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.
Async,
AsyncAnnotationAdvisor,
AbstractAdvisingBeanPostProcessor.setBeforeExistingAdvisors(boolean),
ScheduledAnnotationBeanPostProcessor,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
private java.lang.Class<? extends java.lang.annotation.Annotation> |
asyncAnnotationType |
static java.lang.String |
DEFAULT_TASK_EXECUTOR_BEAN_NAME
The default name of the
TaskExecutor bean to pick up: "taskExecutor". |
private AsyncUncaughtExceptionHandler |
exceptionHandler |
private java.util.concurrent.Executor |
executor |
protected Log |
logger |
advisor, beforeExistingAdvisorsHIGHEST_PRECEDENCE, LOWEST_PRECEDENCE| Constructor and Description |
|---|
AsyncAnnotationBeanPostProcessor() |
| Modifier and Type | Method and Description |
|---|---|
void |
setAsyncAnnotationType(java.lang.Class<? extends java.lang.annotation.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 the
AsyncUncaughtExceptionHandler to use to handle uncaught
exceptions thrown by asynchronous method executions. |
void |
setExecutor(java.util.concurrent.Executor executor)
Set the
Executor to use when invoking methods asynchronously. |
prepareProxyFactorycustomizeProxyFactory, isEligible, isEligible, postProcessAfterInitialization, postProcessBeforeInitialization, setBeforeExistingAdvisorsevaluateProxyInterfaces, getOrder, getProxyClassLoader, isConfigurationCallbackInterface, isInternalLanguageInterface, setBeanClassLoader, setOrder, setProxyClassLoadercopyFrom, isExposeProxy, isFrozen, isOpaque, isOptimize, isProxyTargetClass, setExposeProxy, setFrozen, setOpaque, setOptimize, setProxyTargetClass, toStringpublic static final java.lang.String DEFAULT_TASK_EXECUTOR_BEAN_NAME
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.
AsyncExecutionAspectSupport.DEFAULT_TASK_EXECUTOR_BEAN_NAME,
Constant Field Valuesprotected final Log logger
private java.lang.Class<? extends java.lang.annotation.Annotation> asyncAnnotationType
private java.util.concurrent.Executor executor
private AsyncUncaughtExceptionHandler exceptionHandler
public void setAsyncAnnotationType(java.lang.Class<? extends java.lang.annotation.Annotation> asyncAnnotationType)
Async annotation and the EJB 3.1
javax.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.
asyncAnnotationType - the desired annotation typepublic void setExecutor(java.util.concurrent.Executor executor)
Executor 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 an Executor
bean named "taskExecutor" otherwise. If neither of the two is resolvable,
a local default executor will be created within the interceptor.
public void setExceptionHandler(AsyncUncaughtExceptionHandler exceptionHandler)
AsyncUncaughtExceptionHandler to use to handle uncaught
exceptions thrown by asynchronous method executions.public void setBeanFactory(BeanFactory beanFactory)
BeanFactoryAwareInvoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet() or a custom init-method.
setBeanFactory in interface BeanFactoryAwaresetBeanFactory in class AbstractBeanFactoryAwareAdvisingPostProcessorbeanFactory - owning BeanFactory (never null).
The bean can immediately call methods on the factory.BeanInitializationException