Interface Graceful

All Known Subinterfaces:
Connector, NetworkConnector
All Known Implementing Classes:
AbstractConnector, AbstractNetworkConnector, ContextHandler, Graceful.Shutdown, LocalConnector, MovedContextHandler, NetworkTrafficSelectChannelConnector, NetworkTrafficServerConnector, ServerConnector, ServletContextHandler, StatisticsHandler, WebAppContext

public interface Graceful

Jetty components that wish to be part of a Graceful shutdown implement this interface so that the shutdown() method will be called to initiate a shutdown. Shutdown operations can fall into the following categories:

  • Preventing new load from being accepted (eg connectors stop accepting connections)
  • Preventing existing load expanding (eg stopping existing connections accepting new requests)
  • Waiting for existing load to complete (eg waiting for active request count to reduce to 0)
  • Performing cleanup operations that may take time (eg closing an SSL connection)

The Future returned by the the shutdown call will be completed to indicate the shutdown operation is completed. Some shutdown operations may be instantaneous and always return a completed future.

Graceful shutdown is typically orchestrated by the doStop methods of Server or ContextHandler (for a full or partial shutdown respectively).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    A utility Graceful that uses a FutureCallback to indicate if shutdown is completed.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
     
  • Method Details

    • shutdown

      Future<Void> shutdown()
    • isShutdown

      boolean isShutdown()