Class ShutdownHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.Handler.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.ShutdownHandler

All Implemented Interfaces:

Handler, Handler.Container, Handler.Singleton, Request.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.thread.Invocable

public class ShutdownHandler
extends Handler.Wrapper

A Handler that initiates a Shutdown of the Jetty Server it belongs to.

Used to trigger shutdown of a Jetty Server instance

• If exitJvm is set to true a hard System.exit(int) call will be performed.

Server Setup Example:

Server server = new Server(8080);
String shutdownToken = "secret password";
boolean exitJvm = false;
ShutdownHandler shutdown = new ShutdownHandler(shutdownToken, exitJvm));
shutdown.setHandler(someOtherHandler);
server.setHandler(someOtherHandlers);
server.start();

Client Triggering Example

public static void attemptShutdown(int port, String shutdownToken) {
  try {
    String encodedToken = URLEncoder.encode(shutdownToken);
    URI uri = URI.create("http://localhost:%d/shutdown?token=%s".formatted(port, shutdownCookie));
    HttpClient httpClient = HttpClient.newBuilder().build();
    HttpRequest httpRequest = HttpRequest.newBuilder(shutdownURI)
        .POST(HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse<String> httpResponse = httpClient.send(httpRequest,
        HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
    Assertions.assertEquals(200, httpResponse.statusCode());
    System.out.println(httpResponse.body());
    logger.info("Shutting down " + uri + ": " + httpResponse.body());
  } catch (IOException | InterruptedException e) {
    logger.debug("Shutdown Handler not available");
    // Okay - the server is not running
    throw new RuntimeException(e);
  }
}

Nested Class Summary

Nested classes/interfaces inherited from class Handler.Abstract

Handler.Abstract.NonBlocking

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface Handler

Handler.Abstract, Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface Request.Handler

Request.Handler.AbortException

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
ShutdownHandler(String shutdownToken)	Creates a Handler that lets the server be shut down remotely (but only from localhost).
ShutdownHandler(String shutdownToken, boolean exitJVM)	Creates a Handler that lets the server be shut down remotely (but only from localhost).
ShutdownHandler(Handler handler, String shutdownPath, String shutdownToken, boolean exitJVM)	Creates a Handler that lets the server be shut down remotely (but only from localhost).

Method Summary

Modifier and Type	Method	Description
boolean	handle(Request request, Response response, org.eclipse.jetty.util.Callback callback)	Invoked to handle the passed HTTP request and response.
boolean	isExitJvm()
void	setExitJvm(boolean exitJvm)

Methods inherited from class Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class Handler.Abstract

destroy, doStart, doStop, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Destroyable

destroy

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface Handler

getServer, setServer

Methods inherited from interface Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

ShutdownHandler

public ShutdownHandler(String shutdownToken)

Creates a Handler that lets the server be shut down remotely (but only from localhost).

Parameters:

shutdownToken - a secret password to avoid unauthorized shutdown attempts

ShutdownHandler

public ShutdownHandler(String shutdownToken,
 boolean exitJVM)

Creates a Handler that lets the server be shut down remotely (but only from localhost).

Parameters:

shutdownToken - a secret password to avoid unauthorized shutdown attempts

exitJVM - If true, when the shutdown is executed, the handler class System.exit()

ShutdownHandler

public ShutdownHandler(Handler handler,
 String shutdownPath,
 String shutdownToken,
 boolean exitJVM)

Creates a Handler that lets the server be shut down remotely (but only from localhost).

Parameters:

handler - the handler to wrap

shutdownPath - the path to respond to shutdown requests against (default is "/shutdown")

shutdownToken - a secret password to avoid unauthorized shutdown attempts

exitJVM - If true, when the shutdown is executed, the handler class System.exit()

Method Details

handle

public boolean handle(Request request,
 Response response,
 org.eclipse.jetty.util.Callback callback)
               throws Exception

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 interface Request.Handler

Overrides:

handle in class Handler.Wrapper

Parameters:

request - the HTTP request to handle

response - the HTTP response to handle

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

• Request.Handler.AbortException

setExitJvm

public void setExitJvm(boolean exitJvm)

isExitJvm

public boolean isExitJvm()