me.alidg.errors.adapter.attributes

Class ServletErrorAttributes

java.lang.Object

org.springframework.boot.web.servlet.error.DefaultErrorAttributes

me.alidg.errors.adapter.attributes.ServletErrorAttributes

All Implemented Interfaces:

org.springframework.boot.web.servlet.error.ErrorAttributes, org.springframework.core.Ordered, org.springframework.web.servlet.HandlerExceptionResolver

public class ServletErrorAttributes
extends org.springframework.boot.web.servlet.error.DefaultErrorAttributes

Custom implementation of ErrorAttributes which adapts the handled HttpError to a Spring Boot's compatible error attributes representation.

Author:

Ali Dehghani

See Also:

HttpError, HttpErrorAttributesAdapter, BasicErrorController

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ServletErrorAttributes(WebErrorHandlers webErrorHandlers, HttpErrorAttributesAdapter httpErrorAttributesAdapter) Initializes the error attributes with required dependencies.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getErrorAttributes(org.springframework.web.context.request.WebRequest webRequest, boolean includeStackTrace) Extracts the thrown exception from the request attributes.

Methods inherited from class org.springframework.boot.web.servlet.error.DefaultErrorAttributes

getError, getOrder, resolveException

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletErrorAttributes

public ServletErrorAttributes(WebErrorHandlers webErrorHandlers,
                              HttpErrorAttributesAdapter httpErrorAttributesAdapter)

Initializes the error attributes with required dependencies.

Parameters:

webErrorHandlers - To handle exceptions.

httpErrorAttributesAdapter - To adapt our representation of an error to Spring Boot's representation.

Throws:

NullPointerException - When one of the required parameters is null.

Method Detail

getErrorAttributes

public Map<String,Object> getErrorAttributes(org.springframework.web.context.request.WebRequest webRequest,
                                             boolean includeStackTrace)

Extracts the thrown exception from the request attributes. If it was null, then checks the stored status code and tries its best to find an exception related to that status code. Finally, handles the exception using the webErrorHandlers and adapts the returned HttpError to a Spring Boot compatible representation.

Specified by:

getErrorAttributes in interface org.springframework.boot.web.servlet.error.ErrorAttributes

Overrides:

getErrorAttributes in class org.springframework.boot.web.servlet.error.DefaultErrorAttributes

Parameters:

webRequest - The current HTTP request.

includeStackTrace - Whether or not to include the stack trace in the error attributes.

Returns:

Error details.