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:
- 2.0.0
- Author:
- Phillip Webb, Scott Frederick
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Name of therequest attribute
holding the error resolved by theErrorAttributes
implementation. -
Method Summary
Modifier and TypeMethodDescriptiongetError
(WebRequest webRequest) Return the underlying cause of the error ornull
if the error cannot be extracted.getErrorAttributes
(WebRequest webRequest, ErrorAttributeOptions options) Returns aMap
of the error attributes.
-
Field Details
-
ERROR_ATTRIBUTE
Name of therequest attribute
holding the error resolved by theErrorAttributes
implementation.- Since:
- 2.5.0
-
-
Method Details
-
getErrorAttributes
Returns aMap
of the error attributes. The map can be used as the model of an error pageModelAndView
, or returned as a@ResponseBody
.- Parameters:
webRequest
- the source requestoptions
- options for error attribute contents- Returns:
- a map of error attributes
- Since:
- 2.3.0
-
getError
Return the underlying cause of the error ornull
if the error cannot be extracted.- Parameters:
webRequest
- the source request- Returns:
- the
Exception
that caused the error ornull
-