Top Description Constructors Methods
org.springframework.web.context.request.async

public Class TimeoutCallableProcessingInterceptor

extends Object
implements CallableProcessingInterceptor
Class Inheritance
All Implemented Interfaces
org.springframework.web.context.request.async.CallableProcessingInterceptor
Imports
java.util.concurrent.Callable, org.springframework.web.context.request.NativeWebRequest
Sends a 503 (SERVICE_UNAVAILABLE) in case of a timeout if the response is not already committed. As of 4.2.8 this is done indirectly by setting the result to an AsyncRequestTimeoutException which is then handled by Spring MVC's default exception handling as a 503 error.

Registered at the end, after all other interceptors and therefore invoked only if no other interceptor handles the timeout.

Note that according to RFC 7231, a 503 without a 'Retry-After' header is interpreted as a 500 error and the client should not retry. Applications can install their own interceptor to handle a timeout and add a 'Retry-After' header if necessary.

Author
Rossen Stoyanchev
Since
3.2

Constructor Summary

AccessConstructor and Description
public
TimeoutCallableProcessingInterceptor()

Method Summary

Modifier and TypeMethod and Description
public <T> Object
handleTimeout(NativeWebRequest
the current request
request, Callable<T>
the task for the current async request
task)

Overrides default org.springframework.web.context.request.async.CallableProcessingInterceptor.handleTimeout.

Invoked from a container thread when the async request times out before the Callable task completes.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

TimeoutCallableProcessingInterceptorback to summary
public TimeoutCallableProcessingInterceptor()

Method Detail

handleTimeoutback to summary
public <T> Object handleTimeout(NativeWebRequest request, Callable<T> task) throws Exception

Overrides default org.springframework.web.context.request.async.CallableProcessingInterceptor.handleTimeout.

Doc from org.springframework.web.context.request.async.CallableProcessingInterceptor.handleTimeout.

Invoked from a container thread when the async request times out before the Callable task completes. Implementations may return a value, including an Exception, to use instead of the value the Callable did not return in time.

The default implementation always returns RESULT_NONE.

Parameters
request:NativeWebRequest

the current request

task:Callable<T>

the task for the current async request

Returns:Object

a concurrent result value; if the value is anything other than RESULT_NONE or RESPONSE_HANDLED, concurrent processing is resumed and subsequent interceptors are not invoked

Annotations
@Override
Exceptions
Exception:
in case of errors