Package org.springframework.web.reactive.result.method.annotation

Class ResponseEntityExceptionHandler

java.lang.Object

org.springframework.web.reactive.result.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 WebFlux raised exceptions by returning a ResponseEntity with RFC 7807 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.server.ServerWebExchange) to override common handling of all exceptions, or override createResponseEntity(java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange) to intercept the final step of creating the ResponseEntity from the selected HTTP status code, headers, and body.

Since:

6.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field	Description
protected final Log	logger	Common logger for use in subclasses.

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, ServerWebExchange exchange)	Convenience method to create a ProblemDetail for any exception that doesn't implement ErrorResponse, also performing a MessageSource lookup for the "detail" field.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	createResponseEntity(Object body, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Create the ResponseEntity to use from the given body, headers, and statusCode.
protected MessageSource	getMessageSource()	Get the MessageSource that this exception handler uses.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleErrorResponseException(ErrorResponseException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of any ErrorResponseException.
final reactor.core.publisher.Mono<ResponseEntity<Object>>	handleException(Exception ex, ServerWebExchange exchange)	Handle all exceptions raised within Spring MVC handling of the request.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleExceptionInternal(Exception ex, Object body, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Internal handler method that all others in this class delegate to, for common handling, and for the creation of a ResponseEntity.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleMethodNotAllowedException(MethodNotAllowedException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of MethodNotAllowedException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleMissingRequestValueException(MissingRequestValueException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of MissingRequestValueException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleNotAcceptableStatusException(NotAcceptableStatusException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of NotAcceptableStatusException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleResponseStatusException(ResponseStatusException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of any ResponseStatusException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleServerErrorException(ServerErrorException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of ServerErrorException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleServerWebInputException(ServerWebInputException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of ServerWebInputException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleUnsatisfiedRequestParameterException(UnsatisfiedRequestParameterException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of UnsatisfiedRequestParameterException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleUnsupportedMediaTypeStatusException(UnsupportedMediaTypeStatusException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of UnsupportedMediaTypeStatusException.
protected reactor.core.publisher.Mono<ResponseEntity<Object>>	handleWebExchangeBindException(WebExchangeBindException ex, HttpHeaders headers, HttpStatusCode status, ServerWebExchange exchange)	Customize the handling of WebExchangeBindException.
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

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({MethodNotAllowedException.class,NotAcceptableStatusException.class,UnsupportedMediaTypeStatusException.class,MissingRequestValueException.class,UnsatisfiedRequestParameterException.class,WebExchangeBindException.class,ServerWebInputException.class,ServerErrorException.class,ResponseStatusException.class,ErrorResponseException.class})
public final reactor.core.publisher.Mono<ResponseEntity<Object>> handleException(Exception ex,
 ServerWebExchange exchange)

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

Parameters:

ex - the exception to handle

exchange - the current request-response

handleMethodNotAllowedException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleMethodNotAllowedException(MethodNotAllowedException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of MethodNotAllowedException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleNotAcceptableStatusException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleNotAcceptableStatusException(NotAcceptableStatusException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of NotAcceptableStatusException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleUnsupportedMediaTypeStatusException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleUnsupportedMediaTypeStatusException(UnsupportedMediaTypeStatusException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of UnsupportedMediaTypeStatusException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleMissingRequestValueException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleMissingRequestValueException(MissingRequestValueException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of MissingRequestValueException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleUnsatisfiedRequestParameterException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleUnsatisfiedRequestParameterException(UnsatisfiedRequestParameterException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of UnsatisfiedRequestParameterException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleWebExchangeBindException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleWebExchangeBindException(WebExchangeBindException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of WebExchangeBindException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleServerWebInputException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleServerWebInputException(ServerWebInputException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of ServerWebInputException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleResponseStatusException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleResponseStatusException(ResponseStatusException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of any ResponseStatusException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleServerErrorException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleServerErrorException(ServerErrorException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

Customize the handling of ServerErrorException.

This method delegates to handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatusCode, org.springframework.web.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

handleErrorResponseException

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleErrorResponseException(ErrorResponseException ex,
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

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.server.ServerWebExchange).

Parameters:

ex - the exception to handle

headers - the headers to use for the response

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

createProblemDetail

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

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, falling back on ErrorResponse.getDefaultDetailMessageCode(Class, String)

detailMessageArguments - the arguments to go with the detailMessageCode

Returns:

the created ProblemDetail instance

handleExceptionInternal

protected reactor.core.publisher.Mono<ResponseEntity<Object>> handleExceptionInternal(Exception ex,
 @Nullable
 Object body,
 @Nullable
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

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

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the ResponseEntity for the response

createResponseEntity

protected reactor.core.publisher.Mono<ResponseEntity<Object>> createResponseEntity(@Nullable
 Object body,
 @Nullable
 HttpHeaders headers,
 HttpStatusCode status,
 ServerWebExchange exchange)

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

status - the status code to use for the response

exchange - the current request and response

Returns:

a Mono with the created ResponseEntity

Since:

6.0