Package org.springframework.web.context.request.async

Class AsyncRequestTimeoutException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.web.context.request.async.AsyncRequestTimeoutException

All Implemented Interfaces:

Serializable, ErrorResponse

public class AsyncRequestTimeoutException
extends RuntimeException
implements ErrorResponse

Exception to be thrown when an async request times out. Alternatively an applications can register a DeferredResultProcessingInterceptor or a CallableProcessingInterceptor to handle the timeout through the MVC Java config or the MVC XML namespace or directly through properties of the RequestMappingHandlerAdapter.

By default the exception will be handled as a 503 error.

Since:

4.2.8

Author:

Rossen Stoyanchev

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.web.ErrorResponse

ErrorResponse.Builder

Constructor Summary

Constructors

Constructor	Description
AsyncRequestTimeoutException()

Method Summary

Modifier and Type	Method	Description
ProblemDetail	getBody()	Return the body for the response, formatted as an RFC 9457 ProblemDetail whose status should match the response status.
HttpStatusCode	getStatusCode()	Return the HTTP status code to use for the response.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.ErrorResponse

getDetailMessageArguments, getDetailMessageArguments, getDetailMessageCode, getHeaders, getTitleMessageCode, getTypeMessageCode, updateAndGetBody

Constructor Details

AsyncRequestTimeoutException

public AsyncRequestTimeoutException()

Method Details

getStatusCode

public HttpStatusCode getStatusCode()

Description copied from interface: ErrorResponse

Return the HTTP status code to use for the response.

Specified by:

getStatusCode in interface ErrorResponse

getBody

public ProblemDetail getBody()

Description copied from interface: ErrorResponse

Return the body for the response, formatted as an RFC 9457 ProblemDetail whose status should match the response status.

Note: The returned ProblemDetail may be updated before the response is rendered, e.g. via ErrorResponse.updateAndGetBody(MessageSource, Locale). Therefore, implementing methods should use an instance field, and should not re-create the ProblemDetail on every call, nor use a static variable.

Specified by:

getBody in interface ErrorResponse