Class AsyncAnnotationAdvisor
java.lang.Object
org.springframework.aop.support.AbstractPointcutAdvisor
org.springframework.scheduling.annotation.AsyncAnnotationAdvisor
- All Implemented Interfaces:
Serializable
,Advisor
,PointcutAdvisor
,Aware
,BeanFactoryAware
,Ordered
Advisor that activates asynchronous method execution through the
Async
annotation. This annotation can be used at the method and type level in
implementation classes as well as in service interfaces.
This advisor detects the EJB 3.1 jakarta.ejb.Asynchronous
annotation as well, treating it exactly like Spring's own Async
.
Furthermore, a custom async annotation type may get specified through the
"asyncAnnotationType"
property.
- Since:
- 3.0
- Author:
- Juergen Hoeller
- See Also:
-
Field Summary
Fields inherited from interface org.springframework.aop.Advisor
EMPTY_ADVICE
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
ConstructorDescriptionCreate a newAsyncAnnotationAdvisor
for bean-style configuration.AsyncAnnotationAdvisor
(Executor executor, AsyncUncaughtExceptionHandler exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.AsyncAnnotationAdvisor
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor. -
Method Summary
Modifier and TypeMethodDescriptionprotected Advice
buildAdvice
(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) protected Pointcut
buildPointcut
(Set<Class<? extends Annotation>> asyncAnnotationTypes) Calculate a pointcut for the given async annotation types, if any.Return the advice part of this aspect.Get the Pointcut that drives this advisor.void
setAsyncAnnotationType
(Class<? extends Annotation> asyncAnnotationType) Set the 'async' annotation type.void
setBeanFactory
(BeanFactory beanFactory) Set theBeanFactory
to be used when looking up executors by qualifier.Methods inherited from class org.springframework.aop.support.AbstractPointcutAdvisor
equals, getOrder, hashCode, setOrder
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.aop.Advisor
isPerInstance
-
Constructor Details
-
AsyncAnnotationAdvisor
public AsyncAnnotationAdvisor()Create a newAsyncAnnotationAdvisor
for bean-style configuration. -
AsyncAnnotationAdvisor
public AsyncAnnotationAdvisor(@Nullable Executor executor, @Nullable AsyncUncaughtExceptionHandler exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.- Parameters:
executor
- the task executor to use for asynchronous methods (can benull
to trigger default executor resolution)exceptionHandler
- theAsyncUncaughtExceptionHandler
to use to handle unexpected exception thrown by asynchronous method executions- See Also:
-
AsyncAnnotationAdvisor
public AsyncAnnotationAdvisor(@Nullable Supplier<Executor> executor, @Nullable Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Create a newAsyncAnnotationAdvisor
for the given task executor.- Parameters:
executor
- the task executor to use for asynchronous methods (can benull
to trigger default executor resolution)exceptionHandler
- theAsyncUncaughtExceptionHandler
to use to handle unexpected exception thrown by asynchronous method executions- Since:
- 5.1
- See Also:
-
-
Method Details
-
setAsyncAnnotationType
Set the 'async' annotation type.The default async annotation type is the
Async
annotation, as well as the EJB 3.1jakarta.ejb.Asynchronous
annotation (if present).This setter property exists so that developers can provide their own (non-Spring-specific) annotation type to indicate that a method is to be executed asynchronously.
- Parameters:
asyncAnnotationType
- the desired annotation type
-
setBeanFactory
Set theBeanFactory
to be used when looking up executors by qualifier.- Specified by:
setBeanFactory
in interfaceBeanFactoryAware
- Parameters:
beanFactory
- owning BeanFactory (nevernull
). The bean can immediately call methods on the factory.- See Also:
-
getAdvice
Description copied from interface:Advisor
Return the advice part of this aspect. An advice may be an interceptor, a before advice, a throws advice, etc. -
getPointcut
Description copied from interface:PointcutAdvisor
Get the Pointcut that drives this advisor.- Specified by:
getPointcut
in interfacePointcutAdvisor
-
buildAdvice
-
buildPointcut
Calculate a pointcut for the given async annotation types, if any.- Parameters:
asyncAnnotationTypes
- the async annotation types to introspect- Returns:
- the applicable Pointcut object, or
null
if none
-