Package org.springframework.boot.web.server

Class ErrorPage

java.lang.Object
org.springframework.boot.web.server.ErrorPage
public class ErrorPage extends Object
Simple server-independent abstraction for error pages. Roughly equivalent to the <error-page> element traditionally found in web.xml.
Since:
2.0.0

  • Constructor Details

    • ErrorPage

      public ErrorPage(String path)

    • ErrorPage

      public ErrorPage(org.springframework.http.HttpStatus status, String path)

    • ErrorPage

      public ErrorPage(Class<? extends Throwable> exception, String path)

  • Method Details

    • getPath

      public String getPath()
      The path to render (usually implemented as a forward), starting with "/". A custom controller or servlet path can be used, or if the server supports it, a template path (e.g. "/error.jsp").
      Returns:
      the path that will be rendered for this error

    • getException

      public Class<? extends Throwable> getException()
      Returns the exception type (or null for a page that matches by status).
      Returns:
      the exception type or null

    • getStatus

      public org.springframework.http.HttpStatus getStatus()
      The HTTP status value that this error page matches (or null for a page that matches by exception).
      Returns:
      the status or null

    • getStatusCode

      public int getStatusCode()
      The HTTP status value that this error page matches.
      Returns:
      the status value (or 0 for a page that matches any status)

    • getExceptionName

      public String getExceptionName()
      The exception type name.
      Returns:
      the exception type name (or null if there is none)

    • isGlobal

      public boolean isGlobal()
      Return if this error page is a global one (matches all unmatched status and exception types).
      Returns:
      if this is a global error page

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object