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:int

The error code that will be sent

reason:String

The reason for the error code (may be null)

fields:HttpFields.Mutable

The header fields that will be sent with the response.

Returns:ByteBuffer

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

Get the cacheControl.

Returns:String

the cacheControl header to set on error responses.

Annotations

@ManagedAttribute:The value of the Cache-Control response header

Implements org.eclipse.jetty.server.Request.Handler.handle.

Doc from org.eclipse.jetty.server.Request.Handler.handle.

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;
}

Parameters

request:Request

the HTTP request to handle

response:Response

the HTTP response to handle

callback:Callback

the callback to complete when the handling is complete

Returns:boolean

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.

Annotations

@Override

Exceptions

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.

Annotations

@ManagedAttribute:Whether the error message is shown in the error page title

Returns:boolean

True if stack traces are shown in the error pages

Annotations

@ManagedAttribute:Whether the error page shows the stack trace

Set the cacheControl.

Parameters

cacheControl:String

the cacheControl header to set on error responses.

Set if true, the error message appears in page title.

Parameters

showMessageInTitle:boolean

if true, the error message appears in page title

Parameters

showStacks:boolean

True if stack traces are shown in the error pages