Module org.eclipse.jetty.server

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, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

public class ErrorHandler
extends AbstractHandler

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.Mutable) for bad requests for which a dispatch cannot be done.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ErrorHandler.ErrorPageMapper

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

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

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

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

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_CHARSET
static final String	ERROR_CONTEXT
static final String	ERROR_PAGE

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor	Description
ErrorHandler()

Method Summary

Modifier and Type	Method	Description
ByteBuffer	badMessageError(int status, String reason, org.eclipse.jetty.http.HttpFields.Mutable fields)	Bad Message Error body
boolean	errorPageForMethod(String method)
protected void	generateAcceptableResponse(Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, int code, String message)	Generate an acceptable error response.
protected void	generateAcceptableResponse(Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, int code, String message, String contentType)	Generate an acceptable error response for a mime type.
protected Writer	getAcceptableWriter(Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Deprecated.
String	getCacheControl()	Get the cacheControl.
static ErrorHandler	getErrorHandler(Server server, ContextHandler context)
boolean	getShowMessageInTitle()
void	handle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle a request.
protected void	handleErrorPage(jakarta.servlet.http.HttpServletRequest request, Writer writer, int code, String message)
boolean	isShowServlet()
boolean	isShowStacks()
void	setCacheControl(String cacheControl)	Set the cacheControl.
void	setShowMessageInTitle(boolean showMessageInTitle)
void	setShowServlet(boolean showServlet)
void	setShowStacks(boolean showStacks)
protected void	write(Writer writer, String string)
protected void	writeErrorPage(jakarta.servlet.http.HttpServletRequest request, Writer writer, int code, String message, boolean showStacks)
protected void	writeErrorPageBody(jakarta.servlet.http.HttpServletRequest request, Writer writer, int code, String message, boolean showStacks)
protected void	writeErrorPageHead(jakarta.servlet.http.HttpServletRequest request, Writer writer, int code, String message)
protected void	writeErrorPageMessage(jakarta.servlet.http.HttpServletRequest request, Writer writer, int code, String message, String uri)
protected void	writeErrorPageStacks(jakarta.servlet.http.HttpServletRequest request, Writer writer)

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

destroy, doError, doStart, doStop, getServer, setServer

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

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

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

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

Methods inherited from class java.lang.Object

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

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

getCachedBeans, getEventListeners

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

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

Field Details

ERROR_PAGE

public static final String ERROR_PAGE

See Also:

• Constant Field Values

ERROR_CONTEXT

public static final String ERROR_CONTEXT

See Also:

• Constant Field Values

ERROR_CHARSET

public static final String ERROR_CHARSET

See Also:

• Constant Field Values

Constructor Details

ErrorHandler

public ErrorHandler()

Method Details

errorPageForMethod

public boolean errorPageForMethod(String method)

handle

public void handle(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
            throws IOException,
jakarta.servlet.ServletException

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:

IOException - if unable to handle the request or response processing

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

generateAcceptableResponse

protected void generateAcceptableResponse(Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 int code,
 String message)
                                   throws IOException

Generate an acceptable error response.

This method is called to generate an Error page of a mime type that is acceptable to the user-agent. The Accept header is evaluated in quality order and the method generateAcceptableResponse(Request, HttpServletRequest, HttpServletResponse, int, String, String) is called for each mimetype until the response is written to or committed.

Parameters:

baseRequest - The base request

request - The servlet request (may be wrapped)

response - The response (may be wrapped)

code - the http error code

message - the http error message

Throws:

IOException - if the response cannot be generated

getAcceptableWriter

@Deprecated
protected Writer getAcceptableWriter(Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                              throws IOException

Deprecated.

Returns an acceptable writer for an error page.

Uses the user-agent's Accept-Charset to get response Writer. The acceptable charsets are tested in quality order if they are known to the JVM and the first known is set on ServletResponse.setCharacterEncoding(String) and the ServletResponse.getWriter() method used to return a writer. If there is no Accept-Charset header then ISO-8859-1 is used. If '*' is the highest quality known charset, then utf-8 is used.

Parameters:

baseRequest - The base request

request - The servlet request (may be wrapped)

response - The response (may be wrapped)

Returns:

A Writer if there is a known acceptable charset or null

Throws:

IOException - if a Writer cannot be returned

generateAcceptableResponse

protected void generateAcceptableResponse(Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 int code,
 String message,
 String contentType)
                                   throws IOException

Generate an acceptable error response for a mime type.

This method is called for each mime type in the users agent's Accept header, until Request.isHandled() is true and a response of the appropriate type is generated.

The default implementation handles "text/html", "text/*" and "*/*". The method can be overridden to handle other types. Implementations must immediate produce a response and may not be async.

Parameters:

baseRequest - The base request

request - The servlet request (may be wrapped)

response - The response (may be wrapped)

code - the http error code

message - the http error message

contentType - The mimetype to generate (may be */*or other wildcard)

Throws:

IOException - if a response cannot be generated

handleErrorPage

protected void handleErrorPage(jakarta.servlet.http.HttpServletRequest request,
 Writer writer,
 int code,
 String message)
                        throws IOException

Throws:

IOException

writeErrorPage

protected void writeErrorPage(jakarta.servlet.http.HttpServletRequest request,
 Writer writer,
 int code,
 String message,
 boolean showStacks)
                       throws IOException

Throws:

IOException

writeErrorPageHead

protected void writeErrorPageHead(jakarta.servlet.http.HttpServletRequest request,
 Writer writer,
 int code,
 String message)
                           throws IOException

Throws:

IOException

writeErrorPageBody

protected void writeErrorPageBody(jakarta.servlet.http.HttpServletRequest request,
 Writer writer,
 int code,
 String message,
 boolean showStacks)
                           throws IOException

Throws:

IOException

writeErrorPageMessage

protected void writeErrorPageMessage(jakarta.servlet.http.HttpServletRequest request,
 Writer writer,
 int code,
 String message,
 String uri)
                              throws IOException

Throws:

IOException

writeErrorPageStacks

protected void writeErrorPageStacks(jakarta.servlet.http.HttpServletRequest request,
 Writer writer)
                             throws IOException

Throws:

IOException

badMessageError

public ByteBuffer badMessageError(int status,
 String reason,
 org.eclipse.jetty.http.HttpFields.Mutable fields)

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 String getCacheControl()

Get the cacheControl.

Returns:

the cacheControl header to set on error responses.

setCacheControl

public void setCacheControl(String cacheControl)

Set the cacheControl.

Parameters:

cacheControl - the cacheControl header to set on error responses.

isShowServlet

public boolean isShowServlet()

Returns:

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

setShowServlet

public void setShowServlet(boolean showServlet)

Parameters:

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

isShowStacks

public boolean isShowStacks()

Returns:

True if stack traces are shown in the error pages

setShowStacks

public void setShowStacks(boolean showStacks)

Parameters:

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

setShowMessageInTitle

public void setShowMessageInTitle(boolean showMessageInTitle)

Parameters:

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

getShowMessageInTitle

public boolean getShowMessageInTitle()

write

protected void write(Writer writer,
 String string)
              throws IOException

Throws:

IOException

getErrorHandler

public static ErrorHandler getErrorHandler(Server server,
 ContextHandler context)