public class AsyncExecutionInterceptor extends AsyncExecutionAspectSupport implements MethodInterceptor, org.springframework.core.Ordered
MethodInterceptor
that processes method invocations
asynchronously, using a given AsyncTaskExecutor
.
Typically used with the org.springframework.scheduling.annotation.Async
annotation.
In terms of target method signatures, any parameter types are supported.
However, the return type is constrained to either void
or
java.util.concurrent.Future
. In the latter case, the Future handle
returned from the proxy will be an actual asynchronous Future that can be used
to track the result of the asynchronous method execution. However, since the
target method needs to implement the same signature, it will have to return
a temporary Future handle that just passes the return value through
(like Spring's org.springframework.scheduling.annotation.AsyncResult
or EJB 3.1's javax.ejb.AsyncResult
).
As of Spring 3.1.2 the AnnotationAsyncExecutionInterceptor
subclass is
preferred for use due to its support for executor qualification in conjunction with
Spring's @Async
annotation.
org.springframework.scheduling.annotation.Async
,
org.springframework.scheduling.annotation.AsyncAnnotationAdvisor
,
org.springframework.scheduling.annotation.AnnotationAsyncExecutionInterceptor
Constructor and Description |
---|
AsyncExecutionInterceptor(Executor executor)
Create a new
AsyncExecutionInterceptor . |
Modifier and Type | Method and Description |
---|---|
protected 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.
|
int |
getOrder() |
Object |
invoke(MethodInvocation invocation)
Intercept the given method invocation, submit the actual calling of the method to
the correct task executor and return immediately to the caller.
|
determineAsyncExecutor, setBeanFactory, setExecutor
public AsyncExecutionInterceptor(Executor executor)
AsyncExecutionInterceptor
.executor
- the Executor
(typically a Spring AsyncTaskExecutor
or ExecutorService
) to delegate to.public Object invoke(MethodInvocation invocation) throws Throwable
invoke
in interface MethodInterceptor
invocation
- the method to intercept and make asynchronousFuture
if the original method returns Future
; null
otherwise.Throwable
protected String getExecutorQualifier(Method method)
null
indicates that no specific executor has
been specified and that the default executor
should be used.
This implementation is a no-op for compatibility in Spring 3.1.2. Subclasses may override to provide support for extracting qualifier information, e.g. via an annotation on the given method.
getExecutorQualifier
in class AsyncExecutionAspectSupport
method
- the method to inspect for executor qualifier metadatanull
AsyncExecutionAspectSupport.determineAsyncExecutor(Method)
public int getOrder()
getOrder
in interface org.springframework.core.Ordered