Top Description Fields Constructors Methods
org.eclipse.jetty.server.handler

public Class HotSwapHandler

extends AbstractContainer
implements Singleton
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.server.Handler.Singleton, org.eclipse.jetty.server.Handler.Container, org.eclipse.jetty.server.Handler, org.eclipse.jetty.server.Request.Handler, org.eclipse.jetty.util.thread.Invocable, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.LifeCycle
Imports
org.eclipse.jetty.server.Handler, .Request, .Response, .Server, org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.thread.Invocable

A HandlerContainer that allows a hot swap of a wrapped handler.

Field Summary

Modifier and TypeField and Description
private volatile Handler

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
destroy()

Overrides org.eclipse.jetty.server.Handler.Abstract.destroy.

Implements org.eclipse.jetty.util.component.Destroyable.destroy.

Destroys the managed Destroyable beans in the reverse order they were added.
public Handler

Returns:

Returns the handlers.
getHandler
()

Implements org.eclipse.jetty.server.Handler.Singleton.getHandler.

public Invocable.InvocationType
public boolean
handle(Request
the HTTP request to handle
request
,
Response
the HTTP response to handle
response
,
Callback
the callback to complete when the handling is complete
callback
)

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

Invoked to handle the passed HTTP request and response.

public void
setHandler(Handler
Set the Handler which should be wrapped.
handler
)

Implements org.eclipse.jetty.server.Handler.Singleton.setHandler.

Inherited from org.eclipse.jetty.server.Handler.AbstractContainer:
findContainerOfgetDescendantgetDescendantsisDynamicsetDynamicsetServer

Field Detail

_handlerback to summary
private volatile Handler _handler

Constructor Detail

HotSwapHandlerback to summary
public HotSwapHandler()

Method Detail

destroyback to summary
public void destroy()

Overrides org.eclipse.jetty.server.Handler.Abstract.destroy.

Implements org.eclipse.jetty.util.component.Destroyable.destroy.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.destroy.

Destroys the managed Destroyable beans in the reverse order they were added.

Annotations
@Override
getHandlerback to summary
public Handler getHandler()

Implements org.eclipse.jetty.server.Handler.Singleton.getHandler.

Returns:Handler

Returns the handlers.

getInvocationTypeback to summary
public Invocable.InvocationType getInvocationType()

Overrides org.eclipse.jetty.server.Handler.AbstractContainer.getInvocationType.

Overrides default org.eclipse.jetty.server.Request.Handler.getInvocationType.

Returns:Invocable.InvocationType

Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType.

The InvocationType of this object

Annotations
@Override
handleback to summary
public boolean handle(Request request, Response response, Callback callback) throws Exception

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.
setHandlerback to summary
public void setHandler(Handler handler)

Implements org.eclipse.jetty.server.Handler.Singleton.setHandler.

Parameters
handler:Handler

Set the Handler which should be wrapped.