public class ErrorHandler extends AbstractHandler
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.Modifier and Type | Class and Description |
---|---|
static interface |
ErrorHandler.ErrorPageMapper |
AbstractHandler.ErrorDispatchHandler
AbstractLifeCycle.AbstractLifeCycleListener
LifeCycle.Listener
Container.InheritedListener, Container.Listener
Modifier and Type | Field and Description |
---|---|
static String |
ERROR_CONTEXT |
static String |
ERROR_PAGE |
Constructor and Description |
---|
ErrorHandler() |
Modifier and Type | Method and Description |
---|---|
ByteBuffer |
badMessageError(int status,
String reason,
HttpFields fields)
Bad Message Error body
|
void |
doError(String target,
Request baseRequest,
HttpServletRequest request,
HttpServletResponse response)
Deprecated error page generation
|
boolean |
errorPageForMethod(String method) |
String |
getCacheControl()
Get the cacheControl.
|
static ErrorHandler |
getErrorHandler(Server server,
ContextHandler context) |
boolean |
getShowMessageInTitle() |
void |
handle(String target,
Request baseRequest,
HttpServletRequest request,
HttpServletResponse response)
Handle a request.
|
boolean |
isShowServlet() |
boolean |
isShowStacks() |
void |
setCacheControl(String cacheControl)
Set the cacheControl.
|
void |
setShowMessageInTitle(boolean showMessageInTitle) |
void |
setShowServlet(boolean showServlet) |
void |
setShowStacks(boolean showStacks) |
destroy, getServer, setServer
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
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop
dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named
public static final String ERROR_PAGE
public static final String ERROR_CONTEXT
public boolean errorPageForMethod(String method)
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
Handler
handle
in interface Handler
handle
in class AbstractHandler
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.IOException
- if unable to handle the request or response processingServletException
- if unable to handle the request or response due to underlying servlet issuepublic void doError(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException
AbstractHandler
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.IOException
- if unable to handle the request or response processingpublic ByteBuffer badMessageError(int status, String reason, HttpFields fields)
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.
status
- The error code that will be sentreason
- The reason for the error code (may be null)fields
- The header fields that will be sent with the response.public String getCacheControl()
public void setCacheControl(String cacheControl)
cacheControl
- the cacheControl header to set on error responses.public boolean isShowServlet()
public void setShowServlet(boolean showServlet)
showServlet
- True if the error page will show the Servlet that generated the errorpublic boolean isShowStacks()
public void setShowStacks(boolean showStacks)
showStacks
- True if stack traces are shown in the error pagespublic void setShowMessageInTitle(boolean showMessageInTitle)
showMessageInTitle
- if true, the error message appears in page titlepublic boolean getShowMessageInTitle()
public static ErrorHandler getErrorHandler(Server server, ContextHandler context)
Copyright © 2010 - 2020 Adobe. All Rights Reserved