Class WebAsyncManager

Method Detail

• setAsyncWebRequest

  public void setAsyncWebRequest​(AsyncWebRequest asyncWebRequest)

  Configure the AsyncWebRequest to use. This property may be set more than once during a single request to accurately reflect the current state of the request (e.g. following a forward, request/response wrapping, etc). However, it should not be set while concurrent handling is in progress, i.e. while isConcurrentHandlingStarted() is true.

  Parameters:

  asyncWebRequest - the web request to use

• setTaskExecutor

  public void setTaskExecutor​(AsyncTaskExecutor taskExecutor)

  Configure an AsyncTaskExecutor for use with concurrent processing via startCallableProcessing(Callable, Object...).

  By default a SimpleAsyncTaskExecutor instance is used.

• isConcurrentHandlingStarted

  public boolean isConcurrentHandlingStarted()

  Whether the selected handler for the current request chose to handle the request asynchronously. A return value of "true" indicates concurrent handling is under way and the response will remain open. A return value of "false" means concurrent handling was either not started or possibly that it has completed and the request was dispatched for further processing of the concurrent result.

• hasConcurrentResult

  public boolean hasConcurrentResult()

  Whether a result value exists as a result of concurrent handling.

• getConcurrentResult

  public Object getConcurrentResult()

  Provides access to the result from concurrent handling.

  Returns:

  an Object, possibly an Exception or Throwable if concurrent handling raised one.

  See Also:

  clearConcurrentResult()

• getConcurrentResultContext

  public Object[] getConcurrentResultContext()

  Provides access to additional processing context saved at the start of concurrent handling.

  See Also:

  clearConcurrentResult()

• getCallableInterceptor

  public CallableProcessingInterceptor getCallableInterceptor​(Object key)

  Get the CallableProcessingInterceptor registered under the given key.

  Parameters:

  key - the key

  Returns:

  the interceptor registered under that key, or null if none

• getDeferredResultInterceptor

  public DeferredResultProcessingInterceptor getDeferredResultInterceptor​(Object key)

  Get the DeferredResultProcessingInterceptor registered under the given key.

  Parameters:

  key - the key

  Returns:

  the interceptor registered under that key, or null if none

• registerCallableInterceptor

  public void registerCallableInterceptor​(Object key,
                                          CallableProcessingInterceptor interceptor)

  Register a CallableProcessingInterceptor under the given key.

  Parameters:

  key - the key

  interceptor - the interceptor to register

• registerCallableInterceptors

  public void registerCallableInterceptors​(CallableProcessingInterceptor... interceptors)

  Register a CallableProcessingInterceptor without a key. The key is derived from the class name and hashcode.

  Parameters:

  interceptors - one or more interceptors to register

• registerDeferredResultInterceptor

  public void registerDeferredResultInterceptor​(Object key,
                                                DeferredResultProcessingInterceptor interceptor)

  Register a DeferredResultProcessingInterceptor under the given key.

  Parameters:

  key - the key

  interceptor - the interceptor to register

• registerDeferredResultInterceptors

  public void registerDeferredResultInterceptors​(DeferredResultProcessingInterceptor... interceptors)

  Register one or more DeferredResultProcessingInterceptors without a specified key. The default key is derived from the interceptor class name and hash code.

  Parameters:

  interceptors - one or more interceptors to register

• clearConcurrentResult

  public void clearConcurrentResult()

  Clear concurrentResult and concurrentResultContext.

• startCallableProcessing

  public void startCallableProcessing​(Callable<?> callable,
                                      Object... processingContext)
                               throws Exception

  Start concurrent request processing and execute the given task with an AsyncTaskExecutor. The result from the task execution is saved and the request dispatched in order to resume processing of that result. If the task raises an Exception then the saved result will be the raised Exception.

  Parameters:

  callable - a unit of work to be executed asynchronously

  processingContext - additional context to save that can be accessed via getConcurrentResultContext()

  Throws:

  Exception - if concurrent processing failed to start

  See Also:

  getConcurrentResult(), getConcurrentResultContext()

• startCallableProcessing

  public void startCallableProcessing​(WebAsyncTask<?> webAsyncTask,
                                      Object... processingContext)
                               throws Exception

  Use the given WebAsyncTask to configure the task executor as well as the timeout value of the AsyncWebRequest before delegating to startCallableProcessing(Callable, Object...).

  Parameters:

  webAsyncTask - a WebAsyncTask containing the target Callable

  processingContext - additional context to save that can be accessed via getConcurrentResultContext()

  Throws:

  Exception - if concurrent processing failed to start

• startDeferredResultProcessing

  public void startDeferredResultProcessing​(DeferredResult<?> deferredResult,
                                            Object... processingContext)
                                     throws Exception

  Start concurrent request processing and initialize the given DeferredResult with a DeferredResult.DeferredResultHandler that saves the result and dispatches the request to resume processing of that result. The AsyncWebRequest is also updated with a completion handler that expires the DeferredResult and a timeout handler assuming the DeferredResult has a default timeout result.

  Parameters:

  deferredResult - the DeferredResult instance to initialize

  processingContext - additional context to save that can be accessed via getConcurrentResultContext()

  Throws:

  Exception - if concurrent processing failed to start

  See Also:

  getConcurrentResult(), getConcurrentResultContext()