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:
4.0.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Throwable
    getError(org.springframework.web.context.request.WebRequest webRequest)
    Return the underlying cause of the error or null if the error cannot be extracted.
    default Map<String, @Nullable Object>
    getErrorAttributes(org.springframework.web.context.request.WebRequest webRequest, org.springframework.boot.web.error.ErrorAttributeOptions options)
    Returns a Map of the error attributes.

  • Method Details

    • getErrorAttributes

      default Map<String, @Nullable Object> getErrorAttributes(org.springframework.web.context.request.WebRequest webRequest, org.springframework.boot.web.error.ErrorAttributeOptions options)
      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.
      Parameters:
      webRequest - the source request
      options - options for error attribute contents
      Returns:
      a map of error attributes

    • getError

      @Nullable Throwable getError(org.springframework.web.context.request.WebRequest webRequest)
      Return the underlying cause of the error or null if the error cannot be extracted.
      Parameters:
      webRequest - the source request
      Returns:
      the Exception that caused the error or null