Class ErrorHandler
- All Implemented Interfaces:
Request.Handler
,Invocable
- Direct Known Subclasses:
ErrorPageErrorHandler
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.eclipse.jetty.server.handler.ErrorHandler
ErrorHandler.ErrorRequest
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable
Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task
Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request.Handler
Request.Handler.AbortException
-
Field Summary
Fields inherited from class org.eclipse.jetty.server.handler.ErrorHandler
ERROR_CACHE_CONTROL, ERROR_CONTEXT, ERROR_EXCEPTION, ERROR_MESSAGE, ERROR_METHODS, ERROR_ORIGIN, ERROR_STATUS
Fields inherited from interface org.eclipse.jetty.util.thread.Invocable
__nonBlocking, NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
generateAcceptableResponse
(Request request, Response response, Callback callback, String contentType, List<Charset> charsets, int code, String message, Throwable cause) static Request.Handler
getErrorHandler
(Server server, ContextHandler context) boolean
Invoked to handle the passed HTTP request and response.boolean
writeError
(Request request, Response response, Callback callback, int code) Write an error response, or signal that the error will be handled by a down stream handler.protected void
writeErrorHtmlMessage
(Request request, Writer writer, int code, String message, Throwable cause, String uri) Methods inherited from class org.eclipse.jetty.server.handler.ErrorHandler
badMessageError, computeBufferSize, errorPageForMethod, generateCacheControl, generateResponse, getBufferSize, getCacheControl, getDefaultResponseMimeType, htmlRow, isShowCauses, isShowMessageInTitle, isShowOrigin, isShowStacks, setBufferSize, setCacheControl, setDefaultResponseMimeType, setShowCauses, setShowMessageInTitle, setShowOrigin, setShowStacks, toString, write, writeErrorHtml, writeErrorHtmlBody, writeErrorHtmlHead, writeErrorHtmlMeta, writeErrorHtmlStacks, writeErrorJson, writeErrorOrigin, writeErrorPlain
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.jetty.server.Request.Handler
getInvocationType
-
Constructor Details
-
ErrorHandler
public ErrorHandler()
-
-
Method Details
-
writeError
Description copied from class:ErrorHandler
Write an error response, or signal that the error will be handled by a down stream handler.The default implementation calls
Response.writeError(Request, Response, Callback, int)
and returnstrue
.ErrorHandler
extensions may override this method to modify the state of theRequest
and/orResponse
so that when the method returnsfalse
an error page will be generated by a subsequentHandler
. For example, Servlet implementations override this method to set attributes that trigger a Servlet `sendError` call when theServletHandler
invokes theServletChannel
.- Overrides:
writeError
in classErrorHandler
- Parameters:
request
- The request.response
- The response.callback
- The callback to call when the response is written.code
- The error status code.- Returns:
true
if the error response was written;false
if the state of the request and/or response has been changed so that by continuing normal handling an error response will be generated by a down stream handler.
-
handle
Description copied from interface:Request.Handler
Invoked to handle the passed HTTP request and response.
The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.
Exceptions thrown by this method may be subsequently handled by an error
Request.Handler
, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.The simplest implementation is:
public boolean handle(Request request, Response response, Callback callback) { callback.succeeded(); return true; }
A HelloWorld implementation is:
public boolean handle(Request request, Response response, Callback callback) { response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback); return true; }
- Specified by:
handle
in interfaceRequest.Handler
- Overrides:
handle
in classErrorHandler
- Parameters:
request
- the HTTP request to handleresponse
- the HTTP response to handlecallback
- the callback to complete when the handling is complete- Returns:
- True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.
- Throws:
Exception
- if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.- See Also:
-
generateAcceptableResponse
protected boolean generateAcceptableResponse(Request request, Response response, Callback callback, String contentType, List<Charset> charsets, int code, String message, Throwable cause) throws IOException - Overrides:
generateAcceptableResponse
in classErrorHandler
- Throws:
IOException
-
writeErrorHtmlMessage
protected void writeErrorHtmlMessage(Request request, Writer writer, int code, String message, Throwable cause, String uri) throws IOException - Overrides:
writeErrorHtmlMessage
in classErrorHandler
- Throws:
IOException
-
getErrorHandler
-