Class ResponseEntityExceptionHandler

java.lang.Object

org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

All Implemented Interfaces:

Aware, MessageSourceAware

public abstract class ResponseEntityExceptionHandler
extends Object
implements MessageSourceAware

A class with an @ExceptionHandler method that handles all Spring MVC raised exceptions by returning a ResponseEntity with RFC 9457 formatted error details in the body.

Convenient as a base class of an @ControllerAdvice for global exception handling in an application. Subclasses can override individual methods that handle a specific exception, override handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) to override common handling of all exceptions, or override createResponseEntity(Object, HttpHeaders, HttpStatusCode, WebRequest) to intercept the final step of creating the ResponseEntity from the selected HTTP status code, headers, and body.

Since:

3.2

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	logger	Common logger for use in subclasses.
static final String	PAGE_NOT_FOUND_LOG_CATEGORY	Log category to use when no mapped handler is found for a request.
protected static final org.apache.commons.logging.Log	pageNotFoundLogger	Specific logger to use when no mapped handler is found for a request.

Constructor Summary

Constructors

Constructor	Description
ResponseEntityExceptionHandler()

Method Summary

Modifier and Type	Method	Description
protected ProblemDetail	createProblemDetail(Exception ex, HttpStatusCode status, String defaultDetail, @Nullable String detailMessageCode, Object @Nullable [] detailMessageArguments, WebRequest request)	Convenience method to create a ProblemDetail for any exception that doesn't implement ErrorResponse, also performing a MessageSource lookup for the "detail" field.
protected ResponseEntity<Object>	createResponseEntity(@Nullable Object body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request)	Create the ResponseEntity to use from the given body, headers, and statusCode.
protected @Nullable MessageSource	getMessageSource()	Get the MessageSource that this exception handler uses.
protected @Nullable ResponseEntity<Object>	handleAsyncRequestNotUsableException(AsyncRequestNotUsableException ex, WebRequest request)	Customize the handling of AsyncRequestNotUsableException.
protected @Nullable ResponseEntity<Object>	handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of AsyncRequestTimeoutException.
protected @Nullable ResponseEntity<Object>	handleConversionNotSupported(ConversionNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of ConversionNotSupportedException.
protected @Nullable ResponseEntity<Object>	handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of any ErrorResponseException.
final @Nullable ResponseEntity<Object>	handleException(Exception ex, WebRequest request)	Handle all exceptions raised within Spring MVC handling of the request.
protected @Nullable ResponseEntity<Object>	handleExceptionInternal(Exception ex, @Nullable Object body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request)	Internal handler method that all others in this class delegate to, for common handling, and for the creation of a ResponseEntity.
protected @Nullable ResponseEntity<Object>	handleHandlerMethodValidationException(HandlerMethodValidationException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of HandlerMethodValidationException.
protected @Nullable ResponseEntity<Object>	handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of HttpMediaTypeNotAcceptableException.
protected @Nullable ResponseEntity<Object>	handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of HttpMediaTypeNotSupportedException.
protected @Nullable ResponseEntity<Object>	handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of HttpMessageNotReadableException.
protected @Nullable ResponseEntity<Object>	handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of HttpMessageNotWritableException.
protected @Nullable ResponseEntity<Object>	handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of HttpRequestMethodNotSupportedException.
protected @Nullable ResponseEntity<Object>	handleMaxUploadSizeExceededException(MaxUploadSizeExceededException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of any MaxUploadSizeExceededException.
protected @Nullable ResponseEntity<Object>	handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of MethodArgumentNotValidException.
protected @Nullable ResponseEntity<Object>	handleMethodValidationException(MethodValidationException ex, HttpHeaders headers, HttpStatus status, WebRequest request)	Customize the handling of MethodValidationException.
protected @Nullable ResponseEntity<Object>	handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of MissingPathVariableException.
protected @Nullable ResponseEntity<Object>	handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of MissingServletRequestParameterException.
protected @Nullable ResponseEntity<Object>	handleMissingServletRequestPart(MissingServletRequestPartException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of MissingServletRequestPartException.
protected @Nullable ResponseEntity<Object>	handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of NoHandlerFoundException.
protected @Nullable ResponseEntity<Object>	handleNoResourceFoundException(NoResourceFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of NoResourceFoundException.
protected @Nullable ResponseEntity<Object>	handleServletRequestBindingException(ServletRequestBindingException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of ServletRequestBindingException.
protected @Nullable ResponseEntity<Object>	handleTypeMismatch(TypeMismatchException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)	Customize the handling of TypeMismatchException.
void	setMessageSource(MessageSource messageSource)	Set the MessageSource that this object runs in.

Methods inherited from class Object

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

Field Details

PAGE_NOT_FOUND_LOG_CATEGORY

public static final String PAGE_NOT_FOUND_LOG_CATEGORY

Log category to use when no mapped handler is found for a request.

See Also:

• pageNotFoundLogger
• Constant Field Values

pageNotFoundLogger

protected static final org.apache.commons.logging.Log pageNotFoundLogger

Specific logger to use when no mapped handler is found for a request.

See Also:

• PAGE_NOT_FOUND_LOG_CATEGORY

logger

protected final org.apache.commons.logging.Log logger

Common logger for use in subclasses.

Constructor Details

ResponseEntityExceptionHandler

public ResponseEntityExceptionHandler()

Method Details

setMessageSource

public void setMessageSource(MessageSource messageSource)

Description copied from interface: MessageSourceAware

Set the MessageSource that this object runs in.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Specified by:

setMessageSource in interface MessageSourceAware

Parameters:

messageSource - message source to be used by this object

getMessageSource

protected @Nullable MessageSource getMessageSource()

Get the MessageSource that this exception handler uses.

Since:

6.0.3

handleException

@ExceptionHandler({HttpRequestMethodNotSupportedException.class,HttpMediaTypeNotSupportedException.class,HttpMediaTypeNotAcceptableException.class,MissingPathVariableException.class,MissingServletRequestParameterException.class,MissingServletRequestPartException.class,ServletRequestBindingException.class,MethodArgumentNotValidException.class,HandlerMethodValidationException.class,NoHandlerFoundException.class,NoResourceFoundException.class,AsyncRequestTimeoutException.class,ErrorResponseException.class,MaxUploadSizeExceededException.class,ConversionNotSupportedException.class,TypeMismatchException.class,HttpMessageNotReadableException.class,HttpMessageNotWritableException.class,MethodValidationException.class,AsyncRequestNotUsableException.class})
public final @Nullable ResponseEntity<Object> handleException(Exception ex,
 WebRequest request)
                                                       throws Exception

Handle all exceptions raised within Spring MVC handling of the request.

Parameters:

ex - the exception to handle

request - the current request

Throws:

Exception

handleHttpRequestMethodNotSupported

protected @Nullable ResponseEntity<Object> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of HttpRequestMethodNotSupportedException.

This method logs a warning and delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleHttpMediaTypeNotSupported

protected @Nullable ResponseEntity<Object> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of HttpMediaTypeNotSupportedException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleHttpMediaTypeNotAcceptable

protected @Nullable ResponseEntity<Object> handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of HttpMediaTypeNotAcceptableException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleMissingPathVariable

protected @Nullable ResponseEntity<Object> handleMissingPathVariable(MissingPathVariableException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of MissingPathVariableException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

4.2

handleMissingServletRequestParameter

protected @Nullable ResponseEntity<Object> handleMissingServletRequestParameter(MissingServletRequestParameterException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of MissingServletRequestParameterException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleMissingServletRequestPart

protected @Nullable ResponseEntity<Object> handleMissingServletRequestPart(MissingServletRequestPartException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of MissingServletRequestPartException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleServletRequestBindingException

protected @Nullable ResponseEntity<Object> handleServletRequestBindingException(ServletRequestBindingException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of ServletRequestBindingException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleMethodArgumentNotValid

protected @Nullable ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of MethodArgumentNotValidException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to be written to the response

status - the selected response status

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleHandlerMethodValidationException

protected @Nullable ResponseEntity<Object> handleHandlerMethodValidationException(HandlerMethodValidationException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of HandlerMethodValidationException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to be written to the response

status - the selected response status

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

6.1

handleNoHandlerFoundException

protected @Nullable ResponseEntity<Object> handleNoHandlerFoundException(NoHandlerFoundException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of NoHandlerFoundException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

4.0

handleNoResourceFoundException

protected @Nullable ResponseEntity<Object> handleNoResourceFoundException(NoResourceFoundException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of NoResourceFoundException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

6.1

handleAsyncRequestTimeoutException

protected @Nullable ResponseEntity<Object> handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of AsyncRequestTimeoutException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

4.2.8

handleErrorResponseException

protected @Nullable ResponseEntity<Object> handleErrorResponseException(ErrorResponseException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of any ErrorResponseException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

6.0

handleMaxUploadSizeExceededException

protected @Nullable ResponseEntity<Object> handleMaxUploadSizeExceededException(MaxUploadSizeExceededException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of any MaxUploadSizeExceededException.

This method delegates to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

6.1

handleConversionNotSupported

protected @Nullable ResponseEntity<Object> handleConversionNotSupported(ConversionNotSupportedException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of ConversionNotSupportedException.

By default this method creates a ProblemDetail with the status and a short detail message, and also looks up an override for the detail via MessageSource, before delegating to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleTypeMismatch

protected @Nullable ResponseEntity<Object> handleTypeMismatch(TypeMismatchException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of TypeMismatchException.

By default this method creates a ProblemDetail with the status and a short detail message, and also looks up an override for the detail via MessageSource, before delegating to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleHttpMessageNotReadable

protected @Nullable ResponseEntity<Object> handleHttpMessageNotReadable(HttpMessageNotReadableException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of HttpMessageNotReadableException.

By default this method creates a ProblemDetail with the status and a short detail message, and also looks up an override for the detail via MessageSource, before delegating to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleHttpMessageNotWritable

protected @Nullable ResponseEntity<Object> handleHttpMessageNotWritable(HttpMessageNotWritableException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 WebRequest request)

Customize the handling of HttpMessageNotWritableException.

By default this method creates a ProblemDetail with the status and a short detail message, and also looks up an override for the detail via MessageSource, before delegating to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

handleMethodValidationException

protected @Nullable ResponseEntity<Object> handleMethodValidationException(MethodValidationException ex,
 HttpHeaders headers,
 HttpStatus status,
 WebRequest request)

Customize the handling of MethodValidationException.

By default this method creates a ProblemDetail with the status and a short detail message, and also looks up an override for the detail via MessageSource, before delegating to handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

6.1

handleAsyncRequestNotUsableException

protected @Nullable ResponseEntity<Object> handleAsyncRequestNotUsableException(AsyncRequestNotUsableException ex,
 WebRequest request)

Customize the handling of AsyncRequestNotUsableException.

By default, return null since the response is not usable.

Parameters:

ex - the exception to handle

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

Since:

6.2

createProblemDetail

protected ProblemDetail createProblemDetail(Exception ex,
 HttpStatusCode status,
 String defaultDetail,
 @Nullable String detailMessageCode,
 Object @Nullable [] detailMessageArguments,
 WebRequest request)

Convenience method to create a ProblemDetail for any exception that doesn't implement ErrorResponse, also performing a MessageSource lookup for the "detail" field.

Parameters:

ex - the exception being handled

status - the status to associate with the exception

defaultDetail - default value for the "detail" field

detailMessageCode - the code to use to look up the "detail" field through a MessageSource; if null then ErrorResponse.getDefaultDetailMessageCode(Class, String) is used to determine the default message code to use

detailMessageArguments - the arguments to go with the detailMessageCode

request - the current request

Returns:

the created ProblemDetail instance

Since:

6.0

handleExceptionInternal

protected @Nullable ResponseEntity<Object> handleExceptionInternal(Exception ex,
 @Nullable Object body,
 HttpHeaders headers,
 HttpStatusCode statusCode,
 WebRequest request)

Internal handler method that all others in this class delegate to, for common handling, and for the creation of a ResponseEntity.

The default implementation does the following:

• return null if response is already committed
• set the "jakarta.servlet.error.exception" request attribute if the response status is 500 (INTERNAL_SERVER_ERROR).
• extract the body from ErrorResponse exceptions, if the body is null.

Parameters:

ex - the exception to handle

body - the body to use for the response

headers - the headers to use for the response

statusCode - the status code to use for the response

request - the current request

Returns:

a ResponseEntity for the response to use, possibly null when the response is already committed

createResponseEntity

protected ResponseEntity<Object> createResponseEntity(@Nullable Object body,
 HttpHeaders headers,
 HttpStatusCode statusCode,
 WebRequest request)

Create the ResponseEntity to use from the given body, headers, and statusCode. Subclasses can override this method to inspect and possibly modify the body, headers, or statusCode, for example, to re-create an instance of ProblemDetail as an extension of ProblemDetail.

Parameters:

body - the body to use for the response

headers - the headers to use for the response

statusCode - the status code to use for the response

request - the current request

Returns:

the ResponseEntity instance to use

Since:

6.0