org.springframework.boot.web.servlet.error

Class DefaultErrorAttributes

java.lang.Object

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

All Implemented Interfaces:

ErrorAttributes, Ordered, HandlerExceptionResolver

@Order(value=-2147483648)
public class DefaultErrorAttributes
extends Object
implements ErrorAttributes, HandlerExceptionResolver, 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 (if configured)
• message - The exception message (if configured)
• errors - Any ObjectErrors from a BindingResult exception (if configured)
• trace - The exception stack trace (if configured)
• path - The URL path when the exception was raised

Since:

2.0.0

Author:

Phillip Webb, Dave Syer, Stephane Nicoll, Vedran Pavic, Scott Frederick

See Also:

ErrorAttributes

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
DefaultErrorAttributes() Create a new DefaultErrorAttributes instance.
DefaultErrorAttributes(boolean includeException) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of ErrorAttributeOptions.including(Include...)

Method Summary

Modifier and Type	Method and Description
Throwable	getError(WebRequest webRequest) Return the underlying cause of the error or null if the error cannot be extracted.
Map<String,Object>	getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) Deprecated.
Map<String,Object>	getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) Returns a Map of the error attributes.
protected String	getMessage(WebRequest webRequest, Throwable error) Returns the message to be included as the value of the message error attribute.
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()

Create a new DefaultErrorAttributes instance.

DefaultErrorAttributes

@Deprecated
public DefaultErrorAttributes(boolean includeException)

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of ErrorAttributeOptions.including(Include...)

Create a new DefaultErrorAttributes instance.

Parameters:

includeException - whether to include the "exception" attribute

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

resolveException

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

Specified by:

resolveException in interface HandlerExceptionResolver

getErrorAttributes

public Map<String,Object> getErrorAttributes(WebRequest webRequest,
                                             ErrorAttributeOptions options)

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:

webRequest - the source request

options - options for error attribute contents

Returns:

a map of error attributes

getErrorAttributes

@Deprecated
public Map<String,Object> getErrorAttributes(WebRequest webRequest,
                                                         boolean includeStackTrace)

Deprecated.

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:

webRequest - the source request

includeStackTrace - if stack trace element should be included

Returns:

a map of error attributes

getMessage

protected String getMessage(WebRequest webRequest,
                            Throwable error)

Returns the message to be included as the value of the message error attribute. By default the returned message is the first of the following that is not empty:

1. Value of the RequestDispatcher.ERROR_MESSAGE request attribute.
2. Message of the given error.
3. No message available.

Parameters:

webRequest - current request

error - current error, if any

Returns:

message to include in the error attributes

Since:

2.4.0

getError

public Throwable getError(WebRequest webRequest)

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:

webRequest - the source request

Returns:

the Exception that caused the error or null