org.springframework.boot.web.reactive.error

Interface ErrorAttributes

All Known Implementing Classes:

DefaultErrorAttributes

public interface ErrorAttributes

Provides access to error attributes which can be logged or presented to the user.

Since:

2.0.0

Author:

Brian Clozel, Scott Frederick

See Also:

DefaultErrorAttributes

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.
default Map<String,Object>	getErrorAttributes(ServerRequest request, boolean includeStackTrace) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getErrorAttributes(ServerRequest, ErrorAttributeOptions)
default 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.

Method Detail

getErrorAttributes

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

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getErrorAttributes(ServerRequest, ErrorAttributeOptions)

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.

Parameters:

request - the source request

includeStackTrace - if stack trace attribute should be included

Returns:

a map of error attributes

getErrorAttributes

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

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.

Parameters:

request - the source request

options - options for error attribute contents

Returns:

a map of error attributes

getError

Throwable getError(ServerRequest request)

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

Parameters:

request - the source ServerRequest

Returns:

the Exception that caused the error or null

storeErrorInformation

void storeErrorInformation(Throwable error,
                           ServerWebExchange exchange)

Store the given error information in the current ServerWebExchange.

Parameters:

error - the Exception that caused the error

exchange - the source exchange