org.springframework.boot.web.servlet

Class ErrorPage

java.lang.Object

org.springframework.boot.web.servlet.ErrorPage

Direct Known Subclasses:

ErrorPage

public class ErrorPage
extends Object

Simple container-independent abstraction for servlet error pages. Roughly equivalent to the <error-page> element traditionally found in web.xml.

Since:

1.4.0

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
ErrorPage(Class<? extends Throwable> exception, String path)
ErrorPage(HttpStatus status, String path)
ErrorPage(String path)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Class<? extends Throwable>	getException() Returns the exception type (or null for a page that matches by status).
String	getExceptionName() The exception type name.
String	getPath() The path to render (usually implemented as a forward), starting with "/".
HttpStatus	getStatus() The HTTP status value that this error page matches (or null for a page that matches by exception).
int	getStatusCode() The HTTP status value that this error page matches.
int	hashCode()
boolean	isGlobal() Return if this error page is a global one (matches all unmatched status and exception types).

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorPage

public ErrorPage(String path)

ErrorPage

public ErrorPage(HttpStatus status,
                 String path)

ErrorPage

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

Method Detail

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 container 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 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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object