Jetty components that wish to be part of a Graceful shutdown implement this interface so that the Graceful#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 CompletableFuture 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 and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	Graceful.Shutdown A utility class to assist implementing the Graceful interface.
public static interface	Graceful.ThrowingRunnable

Method Summary

Modifier and Type	Method and Description
public boolean	isShutdown() Returns: True if `shutdown()` has been called.
public CompletableFuture<Void>	Returns: A future that is completed once all load on the component is completed shutdown() Shutdown the component.
public static CompletableFuture<Void>	Returns: A `CompletableFuture` that is complete once all returns from `Graceful#shutdown()` of the contained `Graceful`s are complete. shutdown(Container The container in which to look for `Graceful`s component) Utility method to shutdown all Gracefuls within a container.
public static CompletableFuture<Void>	Returns: the CompletableFuture to be notified when the runnable either completes or fails. shutdown(Graceful.ThrowingRunnable the ThrowingRunnable to run. runnable) Utility method to execute a `ThrowingRunnable` in a new daemon thread and be notified of the result in a `CompletableFuture`.

Method Detail

isShutdown	back to summary
public boolean isShutdown() Returns:boolean True if `shutdown()` has been called.

shutdown	back to summary
public CompletableFuture<Void> shutdown() Shutdown the component. When this method returns, the component should not accept any new load. Returns:CompletableFuture<Void> A future that is completed once all load on the component is completed

shutdown

back to summary

public CompletableFuture<Void> shutdown()

Shutdown the component. When this method returns, the component should not accept any new load.

Returns:CompletableFuture<Void>: A future that is completed once all load on the component is completed

shutdown back to summary

shutdown	back to summary
public static CompletableFuture<Void> shutdown(Container component) Utility method to shutdown all Gracefuls within a container. Parameters component:Container The container in which to look for `Graceful`s Returns:CompletableFuture<Void> A `CompletableFuture` that is complete once all returns from `Graceful#shutdown()` of the contained `Graceful`s are complete.

public static CompletableFuture<Void> shutdown(Container component)

Utility method to shutdown all Gracefuls within a container.

Parameters

component:Container: The container in which to look for Gracefuls

Returns:CompletableFuture<Void>

A CompletableFuture that is complete once all returns from Graceful#shutdown() of the contained Gracefuls are complete.

shutdown back to summary

shutdown	back to summary
public static CompletableFuture<Void> shutdown(Graceful.ThrowingRunnable runnable) Utility method to execute a `ThrowingRunnable` in a new daemon thread and be notified of the result in a `CompletableFuture`. Parameters runnable:Graceful.ThrowingRunnable the ThrowingRunnable to run. Returns:CompletableFuture<Void> the CompletableFuture to be notified when the runnable either completes or fails.

public static CompletableFuture<Void> shutdown(Graceful.ThrowingRunnable runnable)

Utility method to execute a ThrowingRunnable in a new daemon thread and be notified of the result in a CompletableFuture.

Parameters

runnable:Graceful.ThrowingRunnable: the ThrowingRunnable to run.

Returns:CompletableFuture<Void>

the CompletableFuture to be notified when the runnable either completes or fails.

org.eclipse.jetty.util.component back to summary

public abstract Class Graceful.Shutdown

Class Inheritance

extends Object
implements Graceful

java.lang.Object
org.eclipse.jetty.util.component.Graceful.Shutdown

All Implemented Interfaces

org.eclipse.jetty.util.component.Graceful

A utility class to assist implementing the Graceful interface. The isShutdownDone() method should be implemented to check if the CompletableFuture returned by shutdown() should be completed or not. The check() method should be called when any state is changed which may complete the shutdown.

Field Summary

Modifier and Type	Field and Description
pack-priv final Object	_component
pack-priv final AtomicReference<CompletableFuture<Void>>	_done

Constructor Summary

Access	Constructor and Description
protected	Shutdown(Object component)

Method Summary

Modifier and Type	Method and Description
public void	cancel() This method can be called after `shutdown()` has been called, but before `check()` has been called with `isShutdownDone()` having returned true to cancel the effects of the `shutdown()` call.
public void	check() This method should be called whenever the components state has been updated.
public boolean	isShutdown() Implements org.eclipse.jetty.util.component.Graceful.isShutdown.
public abstract boolean	isShutdownDone() Returns: True if the component is shutdown and has no remaining load.
public CompletableFuture<Void>	shutdown() Implements org.eclipse.jetty.util.component.Graceful.shutdown. Shutdown the component.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_component	back to summary
pack-priv final Object _component

_done	back to summary
pack-priv final AtomicReference<CompletableFuture<Void>> _done

Constructor Detail

Shutdown	back to summary
protected Shutdown(Object component)

Method Detail

cancel	back to summary
public void cancel() This method can be called after `shutdown()` has been called, but before `check()` has been called with `isShutdownDone()` having returned true to cancel the effects of the `shutdown()` call.

check	back to summary
public void check() This method should be called whenever the components state has been updated. If `shutdown()` has been called, then `isShutdownDone()` is called by this method and if it returns true then the `Future` returned by `shutdown()` is completed.

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements org.eclipse.jetty.util.component.Graceful.isShutdown. Returns:boolean Doc from org.eclipse.jetty.util.component.Graceful.isShutdown. True if `shutdown()` has been called. Annotations @Override

public boolean isShutdown()

Implements org.eclipse.jetty.util.component.Graceful.isShutdown.

Returns:boolean

Doc from org.eclipse.jetty.util.component.Graceful.isShutdown.

True if shutdown() has been called.

Annotations

@Override

isShutdownDone	back to summary
public abstract boolean isShutdownDone() Returns:boolean True if the component is shutdown and has no remaining load.

shutdown	back to summary
public CompletableFuture<Void> shutdown() Implements org.eclipse.jetty.util.component.Graceful.shutdown. Doc from org.eclipse.jetty.util.component.Graceful.shutdown. Shutdown the component. When this method returns, the component should not accept any new load. Returns:CompletableFuture<Void> A future that is completed once all load on the component is completed Annotations @Override

shutdown

back to summary

public CompletableFuture<Void> shutdown()

Implements org.eclipse.jetty.util.component.Graceful.shutdown.

Doc from org.eclipse.jetty.util.component.Graceful.shutdown.

Shutdown the component. When this method returns, the component should not accept any new load.

Returns:CompletableFuture<Void>

A future that is completed once all load on the component is completed

Annotations