Spring Framework 6.1.4 · org.springframework.scheduling.annotation.AsyncAnnotationAdvisor

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.

Modifier and Type	Field and Description
private final Advice	advice
private Pointcut	pointcut

Constructor Summary

Access	Constructor and Description
public	AsyncAnnotationAdvisor() Create a new `AsyncAnnotationAdvisor` for bean-style configuration.
public	AsyncAnnotationAdvisor(Executor the task executor to use for asynchronous methods (can be `null` to trigger default executor resolution) executor, AsyncUncaughtExceptionHandler the `AsyncUncaughtExceptionHandler` to use to handle unexpected exception thrown by asynchronous method executions exceptionHandler) Create a new `AsyncAnnotationAdvisor` for the given task executor.
public	AsyncAnnotationAdvisor(Supplier<Executor> the task executor to use for asynchronous methods (can be `null` to trigger default executor resolution) executor, Supplier<AsyncUncaughtExceptionHandler> the `AsyncUncaughtExceptionHandler` to use to handle unexpected exception thrown by asynchronous method executions exceptionHandler) Create a new `AsyncAnnotationAdvisor` for the given task executor.

Method Summary

Modifier and Type	Method and Description
protected Advice	buildAdvice(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)
protected Pointcut	Returns: the applicable Pointcut object, or `null` if none buildPointcut(Set<Class<? extends Annotation>> the async annotation types to introspect asyncAnnotationTypes) Calculate a pointcut for the given async annotation types, if any.
public Advice	getAdvice() Implements org.springframework.aop.Advisor.getAdvice. Return the advice part of this aspect.
public Pointcut	getPointcut() Implements org.springframework.aop.PointcutAdvisor.getPointcut. Get the Pointcut that drives this advisor.
public void	setAsyncAnnotationType(Class<? extends Annotation> the desired annotation type asyncAnnotationType) Set the 'async' annotation type.
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.

Inherited from org.springframework.aop.support.AbstractPointcutAdvisor:: equals getOrder hashCode setOrder

Field Detail

advice	back to summary
private final Advice advice

pointcut	back to summary
private Pointcut pointcut

Constructor Detail

AsyncAnnotationAdvisor	back to summary
public AsyncAnnotationAdvisor() Create a new `AsyncAnnotationAdvisor` for bean-style configuration.

AsyncAnnotationAdvisor back to summary

AsyncAnnotationAdvisor	back to summary
public AsyncAnnotationAdvisor(Executor executor, AsyncUncaughtExceptionHandler exceptionHandler) Create a new `AsyncAnnotationAdvisor` for the given task executor. Parameters executor:Executor the task executor to use for asynchronous methods (can be `null` to trigger default executor resolution) exceptionHandler:AsyncUncaughtExceptionHandler the `AsyncUncaughtExceptionHandler` to use to handle unexpected exception thrown by asynchronous method executions See Also `AnnotationAsyncExecutionInterceptor#getDefaultExecutor(BeanFactory)`

public AsyncAnnotationAdvisor(Executor executor, AsyncUncaughtExceptionHandler exceptionHandler)

Create a new AsyncAnnotationAdvisor for the given task executor.

Parameters

executor:Executor: the task executor to use for asynchronous methods (can be null to trigger default executor resolution)
exceptionHandler:AsyncUncaughtExceptionHandler: the AsyncUncaughtExceptionHandler to use to handle unexpected exception thrown by asynchronous method executions

AsyncAnnotationAdvisor back to summary

AsyncAnnotationAdvisor	back to summary
public AsyncAnnotationAdvisor(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler) Create a new `AsyncAnnotationAdvisor` for the given task executor. Parameters executor:Supplier<Executor> the task executor to use for asynchronous methods (can be `null` to trigger default executor resolution) exceptionHandler:Supplier<AsyncUncaughtExceptionHandler> the `AsyncUncaughtExceptionHandler` to use to handle unexpected exception thrown by asynchronous method executions Annotations @SuppressWarnings:unchecked Since 5.1 See Also `AnnotationAsyncExecutionInterceptor#getDefaultExecutor(BeanFactory)`

public AsyncAnnotationAdvisor(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)

Create a new AsyncAnnotationAdvisor for the given task executor.

Parameters

executor:Supplier<Executor>: the task executor to use for asynchronous methods (can be null to trigger default executor resolution)
exceptionHandler:Supplier<AsyncUncaughtExceptionHandler>: the AsyncUncaughtExceptionHandler to use to handle unexpected exception thrown by asynchronous method executions

Annotations

@SuppressWarnings:unchecked

Since

5.1

Method Detail

buildAdvice	back to summary
protected Advice buildAdvice(Supplier<Executor> executor, Supplier<AsyncUncaughtExceptionHandler> exceptionHandler)

buildPointcut back to summary

buildPointcut	back to summary
protected Pointcut buildPointcut(Set<Class<? extends Annotation>> asyncAnnotationTypes) Calculate a pointcut for the given async annotation types, if any. Parameters asyncAnnotationTypes:Set<Class<? extends Annotation>> the async annotation types to introspect Returns:Pointcut the applicable Pointcut object, or `null` if none

protected Pointcut buildPointcut(Set<Class<? extends Annotation>> asyncAnnotationTypes)

Calculate a pointcut for the given async annotation types, if any.

Parameters

asyncAnnotationTypes:Set<Class<? extends Annotation>>: the async annotation types to introspect

Returns:Pointcut

the applicable Pointcut object, or null if none

getAdvice	back to summary
public Advice getAdvice() Implements org.springframework.aop.Advisor.getAdvice. Doc from org.springframework.aop.Advisor.getAdvice. Return the advice part of this aspect. An advice may be an interceptor, a before advice, a throws advice, etc. Returns:Advice the advice that should apply if the pointcut matches Annotations @Override

getAdvice

back to summary

public Advice getAdvice()

Implements org.springframework.aop.Advisor.getAdvice.

Doc from org.springframework.aop.Advisor.getAdvice.

Return the advice part of this aspect. An advice may be an interceptor, a before advice, a throws advice, etc.

Returns:Advice

the advice that should apply if the pointcut matches

Annotations

@Override

getPointcut	back to summary
public Pointcut getPointcut() Implements org.springframework.aop.PointcutAdvisor.getPointcut. Doc from org.springframework.aop.PointcutAdvisor.getPointcut. Get the Pointcut that drives this advisor. Annotations @Override

getPointcut

back to summary

public Pointcut getPointcut()

Implements org.springframework.aop.PointcutAdvisor.getPointcut.

Doc from org.springframework.aop.PointcutAdvisor.getPointcut.

Get the Pointcut that drives this advisor.

Annotations

@Override

setAsyncAnnotationType back to summary

setAsyncAnnotationType	back to summary
public void setAsyncAnnotationType(Class<? extends Annotation> asyncAnnotationType) Set the 'async' annotation type. The default async annotation type is the `Async` annotation, as well as the EJB 3.1 `jakarta.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:Class<? extends Annotation> the desired annotation type

public void setAsyncAnnotationType(Class<? extends Annotation> asyncAnnotationType)

Set the 'async' annotation type.

The default async annotation type is the Async annotation, as well as the EJB 3.1 jakarta.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:Class<? extends Annotation>: the desired annotation type

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. 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

public void setBeanFactory(BeanFactory beanFactory)

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

Set the BeanFactory to be used when looking up executors by qualifier.

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

public Class AsyncAnnotationAdvisor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail