org.openingo.spring.boot.extension.http.request.error

Class AbstractServiceErrorAttributes

java.lang.Object

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

org.openingo.spring.boot.extension.http.request.error.DefaultErrorAttributesX

org.openingo.spring.boot.extension.http.request.error.AbstractServiceErrorAttributes

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultServiceErrorAttributes

public abstract class AbstractServiceErrorAttributes
extends DefaultErrorAttributesX

AbstractServiceErrorAttributes

Author:

Qicz

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractServiceErrorAttributes() Create a new AbstractServiceErrorAttributes instance that included the "exception" attribute , can get the "exception" instance.

Method Summary

Modifier and Type	Method and Description
abstract void	decorateErrorAttributes(Map<String,Object> errorAttributes, Map<String,Object> serviceErrorAttributes) Decorate error attributes, add extension attributes etc.
abstract Object	decorateExceptionCode(Exception exception) Decorate exception error code, custom for your business logic.
abstract String	decorateExceptionMessage(Exception exception) Decorate exception message for your self.
Map<String,Object>	getErrorAttributes(org.springframework.web.context.request.WebRequest webRequest, boolean includeStackTrace) Returns a Map of the error attributes.

Methods inherited from class org.openingo.spring.boot.extension.http.request.error.DefaultErrorAttributesX

getError, getHandlerExecutionException, getMessage, getStatus, resolveException, responseOK

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

getError, getOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServiceErrorAttributes

public AbstractServiceErrorAttributes()

Create a new AbstractServiceErrorAttributes instance that included the "exception" attribute , can get the "exception" instance.

Method Detail

getErrorAttributes

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

Returns a Map of the error attributes. The map can be used as the model of an error page ModelAndView, or returned as a ResponseBody.

Specified by:

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

Overrides:

getErrorAttributes in class DefaultErrorAttributesX

Parameters:

webRequest - the source request

includeStackTrace - if stack trace elements should be included

Returns:

a map of services error attributes

decorateExceptionMessage

public abstract String decorateExceptionMessage(Exception exception)

Decorate exception message for your self.

Parameters:

exception - the exception that got thrown during handler execution

decorateExceptionCode

public abstract Object decorateExceptionCode(Exception exception)

Decorate exception error code, custom for your business logic.

 public Object decorateExceptionCode(Exception exception) {
    if (exception instanceof IndexOutOfBoundsException) {
      return 123;
    }
   return super.decorateExceptionCode(exception);
 }
 

Parameters:

exception - the exception that got thrown during handler execution

decorateErrorAttributes

public abstract void decorateErrorAttributes(Map<String,Object> errorAttributes,
                                             Map<String,Object> serviceErrorAttributes)

Decorate error attributes, add extension attributes etc. the errorAttributes that has exception, handler, message, error, timestamp, status, path params.

Parameters:

errorAttributes - error attributes

serviceErrorAttributes - service error attributes