org.springframework.web.context.request.async

Class TimeoutDeferredResultProcessingInterceptor

java.lang.Object

org.springframework.web.context.request.async.TimeoutDeferredResultProcessingInterceptor

All Implemented Interfaces:

DeferredResultProcessingInterceptor

public class TimeoutDeferredResultProcessingInterceptor
extends java.lang.Object
implements DeferredResultProcessingInterceptor

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 returning AsyncRequestTimeoutException as the result of processing 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.

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
TimeoutDeferredResultProcessingInterceptor()

Method Summary

Modifier and Type	Method and Description
<T> boolean	handleTimeout(NativeWebRequest request, DeferredResult<T> result) Invoked from a container thread when an async request times out before the DeferredResult has been set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.web.context.request.async.DeferredResultProcessingInterceptor

afterCompletion, beforeConcurrentHandling, handleError, postProcess, preProcess

Constructor Detail

TimeoutDeferredResultProcessingInterceptor

public TimeoutDeferredResultProcessingInterceptor()

Method Detail

handleTimeout

public <T> boolean handleTimeout(NativeWebRequest request,
                                 DeferredResult<T> result)
                          throws java.lang.Exception

Description copied from interface: DeferredResultProcessingInterceptor

Invoked from a container thread when an async request times out before the DeferredResult has been set. Implementations may invoke setResult or setErrorResult to resume processing.

Specified by:

handleTimeout in interface DeferredResultProcessingInterceptor

Parameters:

request - the current request

result - the DeferredResult for the current request; if the DeferredResult is set, then concurrent processing is resumed and subsequent interceptors are not invoked

Returns:

true if processing should continue, or false if other interceptors should not be invoked

Throws:

java.lang.Exception - in case of errors