org.springframework.boot.web.reactive.error

Class DefaultErrorAttributes

java.lang.Object

org.springframework.boot.web.reactive.error.DefaultErrorAttributes

All Implemented Interfaces:

ErrorAttributes

public class DefaultErrorAttributes
extends Object
implements ErrorAttributes

Default implementation of ErrorAttributes. Provides the following attributes when possible:

• timestamp - The time that the errors were extracted
• status - The status code
• error - The error reason
• exception - The class name of the root exception (if configured)
• message - The exception message (if configured)
• errors - Any ObjectErrors from a BindingResult exception (if configured)
• trace - The exception stack trace (if configured)
• path - The URL path when the exception was raised
• requestId - Unique ID associated with the current request

Since:

2.0.0

Author:

Brian Clozel, Stephane Nicoll, Michele Mancioppi, Scott Frederick

See Also:

ErrorAttributes

Constructor Summary

Constructors

Constructor and Description
DefaultErrorAttributes() Create a new DefaultErrorAttributes instance.
DefaultErrorAttributes(boolean includeException) Deprecated. since 2.3.0 in favor of ErrorAttributeOptions.including(Include...)

Method Summary

Modifier and Type	Method and Description
Throwable	getError(ServerRequest request) Return the underlying cause of the error or null if the error cannot be extracted.
Map<String,Object>	getErrorAttributes(ServerRequest request, boolean includeStackTrace) Deprecated.
Map<String,Object>	getErrorAttributes(ServerRequest request, ErrorAttributeOptions options) Return a Map of the error attributes.
void	storeErrorInformation(Throwable error, ServerWebExchange exchange) Store the given error information in the current ServerWebExchange.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultErrorAttributes

public DefaultErrorAttributes()

Create a new DefaultErrorAttributes instance.

DefaultErrorAttributes

@Deprecated
public DefaultErrorAttributes(boolean includeException)

Deprecated. since 2.3.0 in favor of ErrorAttributeOptions.including(Include...)

Create a new DefaultErrorAttributes instance.

Parameters:

includeException - whether to include the "exception" attribute

Method Detail

getErrorAttributes

public Map<String,Object> getErrorAttributes(ServerRequest request,
                                             ErrorAttributeOptions options)

Description copied from interface: ErrorAttributes

Return a Map of the error attributes. The map can be used as the model of an error page, or returned as a ServerResponse body.

Specified by:

getErrorAttributes in interface ErrorAttributes

Parameters:

request - the source request

options - options for error attribute contents

Returns:

a map of error attributes

getErrorAttributes

@Deprecated
public Map<String,Object> getErrorAttributes(ServerRequest request,
                                                         boolean includeStackTrace)

Deprecated.

Description copied from interface: ErrorAttributes

Return a Map of the error attributes. The map can be used as the model of an error page, or returned as a ServerResponse body.

Specified by:

getErrorAttributes in interface ErrorAttributes

Parameters:

request - the source request

includeStackTrace - if stack trace attribute should be included

Returns:

a map of error attributes

getError

public Throwable getError(ServerRequest request)

Description copied from interface: ErrorAttributes

Return the underlying cause of the error or null if the error cannot be extracted.

Specified by:

getError in interface ErrorAttributes

Parameters:

request - the source ServerRequest

Returns:

the Exception that caused the error or null

storeErrorInformation

public void storeErrorInformation(Throwable error,
                                  ServerWebExchange exchange)

Description copied from interface: ErrorAttributes

Store the given error information in the current ServerWebExchange.

Specified by:

storeErrorInformation in interface ErrorAttributes

Parameters:

error - the Exception that caused the error

exchange - the source exchange