org.springframework.boot.autoconfigure.web

Class DefaultErrorAttributes

java.lang.Object

org.springframework.boot.autoconfigure.web.DefaultErrorAttributes

All Implemented Interfaces:

ErrorAttributes, Ordered

public class DefaultErrorAttributes
extends Object
implements ErrorAttributes, Ordered

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
• message - The exception message
• errors - Any ObjectErrors from a BindingResult exception
• trace - The exception stack trace
• path - The URL path when the exception was raised

Since:

1.1.0

Author:

Phillip Webb, Dave Syer

See Also:

ErrorAttributes

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
DefaultErrorAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getError(RequestAttributes requestAttributes) Return the underlying cause of the error or null if the error cannot be extracted.
Map<String,Object>	getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) Returns a Map of the error attributes.
int	getOrder()
ModelAndView	resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultErrorAttributes

public DefaultErrorAttributes()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

resolveException

public ModelAndView resolveException(HttpServletRequest request,
                            HttpServletResponse response,
                            Object handler,
                            Exception ex)

getErrorAttributes

public Map<String,Object> getErrorAttributes(RequestAttributes requestAttributes,
                                    boolean includeStackTrace)

Description copied from interface: ErrorAttributes

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 ErrorAttributes

Parameters:

requestAttributes - the source request attributes

includeStackTrace - if stack trace elements should be included

Returns:

a map of error attributes

getError

public Throwable getError(RequestAttributes requestAttributes)

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:

requestAttributes - the source request attributes

Returns:

the Exception that caused the error or null