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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.WebRequest) to override common handling of all exceptions, or override createResponseEntity(java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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 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 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, String detailMessageCode, Object[] 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(Object body, HttpHeaders headers, HttpStatusCode statusCode, WebRequest request)

Create the ResponseEntity to use from the given body, headers, and statusCode.

protected MessageSource

getMessageSource()

Get the MessageSource that this exception handler uses.

protected ResponseEntity<Object>

handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of AsyncRequestTimeoutException.

protected ResponseEntity<Object>

handleBindException(BindException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Deprecated, for removal: This API element is subject to removal in a future version.
as of 6.0 since ModelAttributeMethodProcessor now raises the MethodArgumentNotValidException subclass instead.

protected ResponseEntity<Object>

handleConversionNotSupported(ConversionNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of ConversionNotSupportedException.

protected ResponseEntity<Object>

handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of any ErrorResponseException.

final ResponseEntity<Object>

handleException(Exception ex, WebRequest request)

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

protected ResponseEntity<Object>

handleExceptionInternal(Exception ex, 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 ResponseEntity<Object>

handleHandlerMethodValidationException(HandlerMethodValidationException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of HandlerMethodValidationException.

protected ResponseEntity<Object>

handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of HttpMediaTypeNotAcceptableException.

protected ResponseEntity<Object>

handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of HttpMediaTypeNotSupportedException.

protected ResponseEntity<Object>

handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of HttpMessageNotReadableException.

protected ResponseEntity<Object>

handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of HttpMessageNotWritableException.

protected ResponseEntity<Object>

handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of HttpRequestMethodNotSupportedException.

protected ResponseEntity<Object>

handleMaxUploadSizeExceededException(MaxUploadSizeExceededException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of any MaxUploadSizeExceededException.

protected ResponseEntity<Object>

handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of MethodArgumentNotValidException.

protected ResponseEntity<Object>

handleMethodValidationException(MethodValidationException ex, HttpHeaders headers, HttpStatus status, WebRequest request)

Customize the handling of MethodValidationException.

protected ResponseEntity<Object>

handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of MissingPathVariableException.

protected ResponseEntity<Object>

handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of MissingServletRequestParameterException.

protected ResponseEntity<Object>

handleMissingServletRequestPart(MissingServletRequestPartException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of MissingServletRequestPartException.

protected ResponseEntity<Object>

handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of NoHandlerFoundException.

protected ResponseEntity<Object>

handleNoResourceFoundException(NoResourceFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of NoResourceFoundException.

protected ResponseEntity<Object>

handleServletRequestBindingException(ServletRequestBindingException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)

Customize the handling of ServletRequestBindingException.

protected 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 java.lang.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 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 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
  
  @Nullable protected 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,BindException.class}) @Nullable public final 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
  
  @Nullable protected 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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of HttpMediaTypeNotSupportedException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of HttpMediaTypeNotAcceptableException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleMissingPathVariable(MissingPathVariableException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of MissingPathVariableException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of MissingServletRequestParameterException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleMissingServletRequestPart(MissingServletRequestPartException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of MissingServletRequestPartException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleServletRequestBindingException(ServletRequestBindingException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of ServletRequestBindingException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of MethodArgumentNotValidException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleHandlerMethodValidationException(HandlerMethodValidationException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of HandlerMethodValidationException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of NoHandlerFoundException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleNoResourceFoundException(NoResourceFoundException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of NoResourceFoundException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of AsyncRequestTimeoutException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of any ErrorResponseException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected ResponseEntity<Object> handleMaxUploadSizeExceededException(MaxUploadSizeExceededException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Customize the handling of any MaxUploadSizeExceededException.
  This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected 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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected 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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected 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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected 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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
- handleBindException
  
  @Nullable @Deprecated(since="6.0", forRemoval=true) protected ResponseEntity<Object> handleBindException(BindException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  as of 6.0 since ModelAttributeMethodProcessor now raises the MethodArgumentNotValidException subclass instead.
  
  Customize the handling of BindException.
  By default this method creates a ProblemDetail with the status and a short detail message, and then delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
  
  @Nullable protected 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(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.context.request.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
- createProblemDetail
  
  protected ProblemDetail createProblemDetail(Exception ex, HttpStatusCode status, String defaultDetail, @Nullable String detailMessageCode, @Nullable Object[] 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
  
  @Nullable protected 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, e.g. 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

Class ResponseEntityExceptionHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

PAGE_NOT_FOUND_LOG_CATEGORY

pageNotFoundLogger

logger

Constructor Details

ResponseEntityExceptionHandler

Method Details

setMessageSource

getMessageSource

handleException

handleHttpRequestMethodNotSupported

handleHttpMediaTypeNotSupported

handleHttpMediaTypeNotAcceptable

handleMissingPathVariable

handleMissingServletRequestParameter

handleMissingServletRequestPart

handleServletRequestBindingException

handleMethodArgumentNotValid

handleHandlerMethodValidationException

handleNoHandlerFoundException

handleNoResourceFoundException

handleAsyncRequestTimeoutException

handleErrorResponseException

handleMaxUploadSizeExceededException

handleConversionNotSupported

handleTypeMismatch

handleHttpMessageNotReadable

handleHttpMessageNotWritable

handleBindException

handleMethodValidationException

createProblemDetail

handleExceptionInternal

createResponseEntity