Package org.eclipse.jetty.server.handler

Class ErrorHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.ErrorHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

ErrorPageErrorHandler

@Deprecated(since="2021-05-27")
public class ErrorHandler
extends AbstractHandler

Deprecated.

The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.

Handler for Error pages An ErrorHandler is registered with ContextHandler.setErrorHandler(ErrorHandler) or Server.setErrorHandler(ErrorHandler). It is called by the HttpResponse.sendError method to write an error page via handle(String, Request, HttpServletRequest, HttpServletResponse) or via badMessageError(int, String, HttpFields) for bad requests for which a dispatch cannot be done.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ErrorHandler.ErrorPageMapper	Deprecated.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_CHARSET	Deprecated.
static java.lang.String	ERROR_CONTEXT	Deprecated.
static java.lang.String	ERROR_PAGE	Deprecated.

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
ErrorHandler()	Deprecated.

Method Summary

Modifier and Type	Method	Description
java.nio.ByteBuffer	badMessageError(int status, java.lang.String reason, HttpFields fields)	Deprecated. Bad Message Error body
void	doError(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)	Deprecated.
boolean	errorPageForMethod(java.lang.String method)	Deprecated.
java.lang.String	getCacheControl()	Deprecated. Get the cacheControl.
static ErrorHandler	getErrorHandler(Server server, ContextHandler context)	Deprecated.
boolean	getShowMessageInTitle()	Deprecated.
void	handle(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)	Deprecated. Handle a request.
boolean	isShowServlet()	Deprecated.
boolean	isShowStacks()	Deprecated.
void	setCacheControl(java.lang.String cacheControl)	Deprecated. Set the cacheControl.
void	setShowMessageInTitle(boolean showMessageInTitle)	Deprecated.
void	setShowServlet(boolean showServlet)	Deprecated.
void	setShowStacks(boolean showStacks)	Deprecated.

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

destroy, getServer, setServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Field Detail

ERROR_PAGE

public static final java.lang.String ERROR_PAGE

Deprecated.

See Also:

Constant Field Values

ERROR_CONTEXT

public static final java.lang.String ERROR_CONTEXT

Deprecated.

See Also:

Constant Field Values

ERROR_CHARSET

public static final java.lang.String ERROR_CHARSET

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ErrorHandler

public ErrorHandler()

Deprecated.

Method Detail

errorPageForMethod

public boolean errorPageForMethod(java.lang.String method)

Deprecated.

handle

public void handle(java.lang.String target,
                   Request baseRequest,
                   HttpServletRequest request,
                   HttpServletResponse response)
            throws java.io.IOException,
                   ServletException

Deprecated.

Description copied from interface: Handler

Handle a request.

Specified by:

handle in interface Handler

Specified by:

handle in class AbstractHandler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

java.io.IOException - if unable to handle the request or response processing

ServletException - if unable to handle the request or response due to underlying servlet issue

doError

public void doError(java.lang.String target,
                    Request baseRequest,
                    HttpServletRequest request,
                    HttpServletResponse response)
             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

badMessageError

public java.nio.ByteBuffer badMessageError(int status,
                                           java.lang.String reason,
                                           HttpFields fields)

Deprecated.

Bad Message Error body

Generate an error response body to be sent for a bad message. In this case there is something wrong with the request, so either a request cannot be built, or it is not safe to build a request. This method allows for a simple error page body to be returned and some response headers to be set.

Parameters:

status - The error code that will be sent

reason - The reason for the error code (may be null)

fields - The header fields that will be sent with the response.

Returns:

The content as a ByteBuffer, or null for no body.

getCacheControl

public java.lang.String getCacheControl()

Deprecated.

Get the cacheControl.

Returns:

the cacheControl header to set on error responses.

setCacheControl

public void setCacheControl(java.lang.String cacheControl)

Deprecated.

Set the cacheControl.

Parameters:

cacheControl - the cacheControl header to set on error responses.

isShowServlet

public boolean isShowServlet()

Deprecated.

Returns:

True if the error page will show the Servlet that generated the error

setShowServlet

public void setShowServlet(boolean showServlet)

Deprecated.

Parameters:

showServlet - True if the error page will show the Servlet that generated the error

isShowStacks

public boolean isShowStacks()

Deprecated.

Returns:

True if stack traces are shown in the error pages

setShowStacks

public void setShowStacks(boolean showStacks)

Deprecated.

Parameters:

showStacks - True if stack traces are shown in the error pages

setShowMessageInTitle

public void setShowMessageInTitle(boolean showMessageInTitle)

Deprecated.

Parameters:

showMessageInTitle - if true, the error message appears in page title

getShowMessageInTitle

public boolean getShowMessageInTitle()

Deprecated.

getErrorHandler

public static ErrorHandler getErrorHandler(Server server,
                                           ContextHandler context)

Deprecated.