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:

4.0.0

See Also:

• DefaultErrorAttributes

Method Summary

Modifier and Type	Method	Description
@Nullable Throwable	getError(org.springframework.web.reactive.function.server.ServerRequest request)	Return the underlying cause of the error or null if the error cannot be extracted.
default Map<String, @Nullable Object>	getErrorAttributes(org.springframework.web.reactive.function.server.ServerRequest request, org.springframework.boot.web.error.ErrorAttributeOptions options)	Return a Map of the error attributes.
void	storeErrorInformation(Throwable error, org.springframework.web.server.ServerWebExchange exchange)	Store the given error information in the current ServerWebExchange.

Method Details

getErrorAttributes

default Map<String, @Nullable Object> getErrorAttributes(org.springframework.web.reactive.function.server.ServerRequest request,
 org.springframework.boot.web.error.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

@Nullable Throwable getError(org.springframework.web.reactive.function.server.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,
 org.springframework.web.server.ServerWebExchange exchange)

Store the given error information in the current ServerWebExchange.

Parameters:

error - the Exception that caused the error

exchange - the source exchange