org.springframework.web.server.handler

Class ResponseStatusExceptionHandler

java.lang.Object

org.springframework.web.server.handler.ResponseStatusExceptionHandler

All Implemented Interfaces:

WebExceptionHandler

Direct Known Subclasses:

WebFluxResponseStatusExceptionHandler

public class ResponseStatusExceptionHandler
extends java.lang.Object
implements WebExceptionHandler

Handle ResponseStatusException by setting the response status.

By default exception stack traces are not shown for successfully resolved exceptions. Use setWarnLogCategory(String) to enable logging with stack traces.

Since:

5.0

Author:

Rossen Stoyanchev, Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
private static Log	logger
private Log	warnLogger

Constructor Summary

Constructors

Constructor and Description
ResponseStatusExceptionHandler()

Method Summary

Modifier and Type	Method and Description
protected HttpStatus	determineStatus(java.lang.Throwable ex) Determine the HTTP status implied by the given exception.
private java.lang.String	formatError(java.lang.Throwable ex, ServerHttpRequest request)
<any>	handle(ServerWebExchange exchange, java.lang.Throwable ex) Handle the given exception.
private HttpStatus	resolveStatus(java.lang.Throwable ex)
void	setWarnLogCategory(java.lang.String loggerName) Set the log category for warn logging.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Log logger

warnLogger

@Nullable
private Log warnLogger

Constructor Detail

ResponseStatusExceptionHandler

public ResponseStatusExceptionHandler()

Method Detail

setWarnLogCategory

public void setWarnLogCategory(java.lang.String loggerName)

Set the log category for warn logging.

Default is no warn logging. Specify this setting to activate warn logging into a specific category.

Since:

5.1

See Also:

LogFactory.getLog(String), Logger.getLogger(String)

handle

public <any> handle(ServerWebExchange exchange,
                    java.lang.Throwable ex)

Description copied from interface: WebExceptionHandler

Handle the given exception. A completion signal through the return value indicates error handling is complete while an error signal indicates the exception is still not handled.

Specified by:

handle in interface WebExceptionHandler

Parameters:

exchange - the current exchange

ex - the exception to handle

Returns:

Mono<Void> to indicate when exception handling is complete

formatError

private java.lang.String formatError(java.lang.Throwable ex,
                                     ServerHttpRequest request)

resolveStatus

@Nullable
private HttpStatus resolveStatus(java.lang.Throwable ex)

determineStatus

@Nullable
protected HttpStatus determineStatus(java.lang.Throwable ex)

Determine the HTTP status implied by the given exception.

Parameters:

ex - the exception to introspect

Returns:

the associated HTTP status, if any

Since:

5.0.5