org.springframework.aop.interceptor
Class AsyncExecutionInterceptor

java.lang.Object
  extended by org.springframework.aop.interceptor.AsyncExecutionInterceptor
All Implemented Interfaces:
org.aopalliance.aop.Advice, org.aopalliance.intercept.Interceptor, org.aopalliance.intercept.MethodInterceptor, Ordered

public class AsyncExecutionInterceptor
extends java.lang.Object
implements org.aopalliance.intercept.MethodInterceptor, Ordered

AOP Alliance MethodInterceptor that processes method invocations asynchronously, using a given AsyncTaskExecutor. Typically used with the org.springframework.context.task.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 AsyncResult or EJB 3.1's javax.ejb.AsyncResult).

Since:
3.0
Author:
Juergen Hoeller
See Also:
Async, AsyncAnnotationAdvisor

Field Summary
 
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
 
Constructor Summary
AsyncExecutionInterceptor(AsyncTaskExecutor asyncExecutor)
          Create a new AsyncExecutionInterceptor.
AsyncExecutionInterceptor(java.util.concurrent.Executor asyncExecutor)
          Create a new AsyncExecutionInterceptor.
 
Method Summary
 int getOrder()
          Return the order value of this object, with a higher value meaning greater in terms of sorting.
 java.lang.Object invoke(org.aopalliance.intercept.MethodInvocation invocation)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AsyncExecutionInterceptor

public AsyncExecutionInterceptor(AsyncTaskExecutor asyncExecutor)
Create a new AsyncExecutionInterceptor.

Parameters:
asyncExecutor - the Spring AsyncTaskExecutor to delegate to

AsyncExecutionInterceptor

public AsyncExecutionInterceptor(java.util.concurrent.Executor asyncExecutor)
Create a new AsyncExecutionInterceptor.

Parameters:
asyncExecutor - the java.util.concurrent Executor to delegate to (typically a ExecutorService
Method Detail

invoke

public java.lang.Object invoke(org.aopalliance.intercept.MethodInvocation invocation)
                        throws java.lang.Throwable
Specified by:
invoke in interface org.aopalliance.intercept.MethodInterceptor
Throws:
java.lang.Throwable

getOrder

public int getOrder()
Description copied from interface: Ordered
Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0, with Integer.MAX_VALUE indicating the greatest value. Same order values will result in arbitrary positions for the affected objects.

Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).

Specified by:
getOrder in interface Ordered
Returns:
the order value