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

public Class ShutdownHandler

extends Wrapper
Class Inheritance
Imports
java.net.InetSocketAddress, .SocketAddress, java.util.concurrent.CompletableFuture, org.eclipse.jetty.http.HttpHeader, .HttpStatus, org.eclipse.jetty.io.Content, org.eclipse.jetty.server.Handler, .Request, .Response, org.eclipse.jetty.util.Callback, .Fields, .StringUtil, org.slf4j.Logger, .LoggerFactory

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

Used to trigger shutdown of a Jetty Server instance

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

Field Summary

Modifier and TypeField and Description
private boolean
_exitJvm

private final String
_shutdownPath

private final String
_shutdownToken

private static final Logger
LOG

Hides org.eclipse.jetty.server.Handler.Abstract.LOG.

Constructor Summary

AccessConstructor and Description
public
ShutdownHandler(String
a secret password to avoid unauthorized shutdown attempts
shutdownToken)

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

public
ShutdownHandler(String
a secret password to avoid unauthorized shutdown attempts
shutdownToken, boolean
If true, when the shutdown is executed, the handler class System.exit()
exitJVM)

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

public
ShutdownHandler(Handler
the handler to wrap
handler, String
the path to respond to shutdown requests against (default is "/shutdown")
shutdownPath, String
a secret password to avoid unauthorized shutdown attempts
shutdownToken, boolean
If true, when the shutdown is executed, the handler class System.exit()
exitJVM)

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

Method Summary

Modifier and TypeMethod and Description
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)

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

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

Invoked to handle the passed HTTP request and response.

private boolean
hasCorrectSecurityToken(Request request)

public boolean
isExitJvm()

private boolean
requestFromLocalhost(Request request)

public void
setExitJvm(boolean exitJvm)

private void
shutdownServer()

Inherited from org.eclipse.jetty.server.Handler.Wrapper:
getHandlergetInvocationTypesetHandler

Field Detail

_exitJvmback to summary
private boolean _exitJvm
_shutdownPathback to summary
private final String _shutdownPath
_shutdownTokenback to summary
private final String _shutdownToken
LOGback to summary
private static final Logger LOG

Hides org.eclipse.jetty.server.Handler.Abstract.LOG.

Constructor Detail

ShutdownHandlerback to summary
public ShutdownHandler(String shutdownToken)

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

Parameters
shutdownToken:String

a secret password to avoid unauthorized shutdown attempts

ShutdownHandlerback to summary
public ShutdownHandler(String shutdownToken, boolean exitJVM)

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

Parameters
shutdownToken:String

a secret password to avoid unauthorized shutdown attempts

exitJVM:boolean

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

ShutdownHandlerback to summary
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:Handler

the handler to wrap

shutdownPath:String

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

shutdownToken:String

a secret password to avoid unauthorized shutdown attempts

exitJVM:boolean

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

Method Detail

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

Overrides org.eclipse.jetty.server.Handler.Wrapper.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.
hasCorrectSecurityTokenback to summary
private boolean hasCorrectSecurityToken(Request request)
isExitJvmback to summary
public boolean isExitJvm()
requestFromLocalhostback to summary
private boolean requestFromLocalhost(Request request)
setExitJvmback to summary
public void setExitJvm(boolean exitJvm)
shutdownServerback to summary
private void shutdownServer()