Class ErrorPageErrorHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.ee9.nested.AbstractHandler

org.eclipse.jetty.ee9.nested.ErrorHandler

org.eclipse.jetty.ee9.servlet.ErrorPageErrorHandler

All Implemented Interfaces:

ErrorHandler.ErrorPageMapper, Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

public class ErrorPageErrorHandler
extends ErrorHandler
implements ErrorHandler.ErrorPageMapper

An ErrorHandler that maps exceptions and status codes to URIs for dispatch using the internal ERROR style of dispatch.

Nested Class Summary

Nested classes/interfaces inherited from class ErrorHandler

ErrorHandler.ErrorPageMapper

Nested classes/interfaces inherited from class AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.servlet.ServletContext	_servletContext
static final String	GLOBAL_ERROR_PAGE

Fields inherited from class ErrorHandler

ERROR_CHARSET, ERROR_CONTEXT, ERROR_PAGE

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
ErrorPageErrorHandler()

Method Summary

Modifier and Type	Method	Description
void	addErrorPage(int from, int to, String uri)	Adds ErrorPage mapping for a status code range.
void	addErrorPage(int code, String uri)	Adds ErrorPage mapping for a status code.
void	addErrorPage(Class<? extends Throwable> exception, String uri)	Adds ErrorPage mapping for an exception class.
void	addErrorPage(String exceptionClassName, String uri)	Adds ErrorPage mapping for an exception class.
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
String	getErrorPage(jakarta.servlet.http.HttpServletRequest request)
Map<String,String>	getErrorPages()
boolean	isUnwrapServletException()
void	setErrorPages(Map<String,String> errorPages)	Set a map of Exception class names or error codes as a string to URI string.
void	setUnwrapServletException(boolean unwrapServletException)

Methods inherited from class ErrorHandler

badMessageError, errorPageForMethod, generateAcceptableResponse, generateAcceptableResponse, getAcceptableWriter, getCacheControl, getErrorHandler, getShowMessageInTitle, handle, handleErrorPage, isShowMessageInTitle, isShowServlet, isShowStacks, setCacheControl, setShowMessageInTitle, setShowServlet, setShowStacks, write, writeErrorJson, writeErrorPage, writeErrorPageBody, writeErrorPageHead, writeErrorPageMessage, writeErrorPageStacks, writeErrorPlain

Methods inherited from class AbstractHandler

destroy, doError, doStop, getServer, setServer

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Field Details

GLOBAL_ERROR_PAGE

public static final String GLOBAL_ERROR_PAGE

See Also:

• Constant Field Values

_servletContext

protected jakarta.servlet.ServletContext _servletContext

Constructor Details

ErrorPageErrorHandler

public ErrorPageErrorHandler()

Method Details

isUnwrapServletException

public boolean isUnwrapServletException()

Returns:

True if ServletException is unwrapped for RequestDispatcher.ERROR_EXCEPTION

setUnwrapServletException

public void setUnwrapServletException(boolean unwrapServletException)

Parameters:

unwrapServletException - True if ServletException should be unwrapped for RequestDispatcher.ERROR_EXCEPTION

getErrorPage

public String getErrorPage(jakarta.servlet.http.HttpServletRequest request)

Specified by:

getErrorPage in interface ErrorHandler.ErrorPageMapper

getErrorPages

public Map<String,String> getErrorPages()

setErrorPages

public void setErrorPages(Map<String,String> errorPages)

Set a map of Exception class names or error codes as a string to URI string.

Parameters:

errorPages - a map of Exception class names or error codes as a string to URI string

addErrorPage

public void addErrorPage(Class<? extends Throwable> exception,
 String uri)

Adds ErrorPage mapping for an exception class. This method is called as a result of an exception-type element in a web.xml file or may be called directly

Parameters:

exception - The exception

uri - The URI of the error page.

addErrorPage

public void addErrorPage(String exceptionClassName,
 String uri)

Adds ErrorPage mapping for an exception class. This method is called as a result of an exception-type element in a web.xml file or may be called directly

Parameters:

exceptionClassName - The exception

uri - The URI of the error page.

addErrorPage

public void addErrorPage(int code,
 String uri)

Adds ErrorPage mapping for a status code. This method is called as a result of an error-code element in a web.xml file or may be called directly.

Parameters:

code - The HTTP status code to match

uri - The URI of the error page.

addErrorPage

public void addErrorPage(int from,
 int to,
 String uri)

Adds ErrorPage mapping for a status code range. This method is not available from web.xml and must be called directly.

Parameters:

from - The lowest matching status code

to - The highest matching status code

uri - The URI of the error page.

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class AbstractHandler

Throws:

Exception - If there was a problem starting. Will cause a transition to FAILED state