Thread safe deploy of a Handler.

This method is the equivalent of addHandler(Handler), but its execution is non-blocking and mutually excluded from all other callers to itself and undeployHandler(Handler, Callback). The handler may be added after this call returns.

Parameters

handler:Handler

the handler to deploy

callback:Callback

Called after handler has been added

Annotations

@ManagedAttribute:The paths of the contexts in this collection

Overrides org.eclipse.jetty.server.Handler.Sequence.handle.

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.

Remap the contexts. Normally this is not required as context mapping is maintained as a side effect of setHandlers(Handler[]) However, if configuration changes in the deep handler structure (eg contextpath is changed), then this call will trigger a remapping. This method is mutually excluded from deployHandler(Handler, Callback) and undeployHandler(Handler, Callback)

Annotations

@ManagedOperation:Update the mapping of context path to context

impact:ACTION

Thread safe undeploy of a Handler.

This method is the equivalent of removeHandler(Handler), but its execution is non-block and mutually excluded from all other calls to deployHandler(Handler, Callback) and itself. The handler may be removed after this call returns.

Parameters

handler:Handler

The handler to undeploy

callback:Callback

Called after handler has been removed