Spring Framework 6.1.4 · org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

Modifier and Type	Field and Description
protected final Log	logger Common logger for use in subclasses.
private MessageSource	messageSource
public 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.

Access	Constructor and Description
public	ResponseEntityExceptionHandler()

Method Summary

Modifier and Type	Method and Description
protected ProblemDetail	Returns: the created `ProblemDetail` instance createProblemDetail(Exception the exception being handled ex, HttpStatusCode the status to associate with the exception status, String default value for the "detail" field defaultDetail, String 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 detailMessageCode, Object[] the arguments to go with the detailMessageCode detailMessageArguments, WebRequest the current request 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>	Returns: the `ResponseEntity` instance to use createResponseEntity(Object the body to use for the response body, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response statusCode, WebRequest the current request 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>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleAsyncRequestTimeoutException(AsyncRequestTimeoutException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `AsyncRequestTimeoutException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleBindException(BindException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Deprecated for removal since 6.0. as of 6.0 since `org.springframework.web.method.annotation.ModelAttributeMethodProcessor` now raises the `MethodArgumentNotValidException` subclass instead. Customize the handling of `BindException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleConversionNotSupported(ConversionNotSupportedException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `ConversionNotSupportedException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleErrorResponseException(ErrorResponseException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of any `ErrorResponseException`.
public final ResponseEntity<Object>	handleException(Exception the exception to handle ex, WebRequest the current request request) Handle all exceptions raised within Spring MVC handling of the request.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleExceptionInternal(Exception the exception to handle ex, Object the body to use for the response body, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response statusCode, WebRequest the current request 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>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleHandlerMethodValidationException(HandlerMethodValidationException the exception to handle ex, HttpHeaders the headers to be written to the response headers, HttpStatusCode the selected response status status, WebRequest the current request request) Customize the handling of `HandlerMethodValidationException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `HttpMediaTypeNotAcceptableException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `HttpMediaTypeNotSupportedException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleHttpMessageNotReadable(HttpMessageNotReadableException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `HttpMessageNotReadableException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleHttpMessageNotWritable(HttpMessageNotWritableException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `HttpMessageNotWritableException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `HttpRequestMethodNotSupportedException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleMaxUploadSizeExceededException(MaxUploadSizeExceededException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of any `MaxUploadSizeExceededException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleMethodArgumentNotValid(MethodArgumentNotValidException the exception to handle ex, HttpHeaders the headers to be written to the response headers, HttpStatusCode the selected response status status, WebRequest the current request request) Customize the handling of `MethodArgumentNotValidException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleMethodValidationException(MethodValidationException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatus the status code to use for the response status, WebRequest the current request request) Customize the handling of `MethodValidationException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleMissingPathVariable(MissingPathVariableException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `MissingPathVariableException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleMissingServletRequestParameter(MissingServletRequestParameterException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `MissingServletRequestParameterException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleMissingServletRequestPart(MissingServletRequestPartException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `MissingServletRequestPartException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleNoHandlerFoundException(NoHandlerFoundException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `NoHandlerFoundException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleNoResourceFoundException(NoResourceFoundException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `NoResourceFoundException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleServletRequestBindingException(ServletRequestBindingException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `ServletRequestBindingException`.
protected ResponseEntity<Object>	Returns: a `ResponseEntity` for the response to use, possibly `null` when the response is already committed handleTypeMismatch(TypeMismatchException the exception to handle ex, HttpHeaders the headers to use for the response headers, HttpStatusCode the status code to use for the response status, WebRequest the current request request) Customize the handling of `TypeMismatchException`.
public void	setMessageSource(MessageSource message source to be used by this object messageSource) Implements org.springframework.context.MessageSourceAware.setMessageSource. 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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public abstract Class ResponseEntityExceptionHandler

Field Summary

Constructor Summary

Method Summary