Module org.elasticsearch.server

Package org.elasticsearch.node

Class ShutdownPrepareService

java.lang.Object

org.elasticsearch.node.ShutdownPrepareService

public class ShutdownPrepareService
extends Object

This class was created to extract out the logic from Node.prepareForClose() to facilitate testing.

Invokes hooks to prepare this node to be closed. This should be called when Elasticsearch receives a request to shut down gracefully from the underlying operating system, before system resources are closed.

Note that this class is part of infrastructure to react to signals from the operating system - most graceful shutdown logic should use Node Shutdown, see NodesShutdownMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<TimeValue>	MAXIMUM_REINDEXING_TIMEOUT_SETTING
static final Setting<TimeValue>	MAXIMUM_SHUTDOWN_TIMEOUT_SETTING

Constructor Summary

Constructors

Constructor	Description
ShutdownPrepareService(Settings settings, HttpServerTransport httpServerTransport, TaskManager taskManager, TerminationHandler terminationHandler)

Method Summary

Modifier and Type	Method	Description
void	addShutdownHook(String name, Runnable action)
boolean	isShuttingDown()
void	prepareForShutdown()	Invokes hooks to prepare this node to be closed.

Methods inherited from class java.lang.Object

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

Field Details

MAXIMUM_SHUTDOWN_TIMEOUT_SETTING

public static final Setting<TimeValue> MAXIMUM_SHUTDOWN_TIMEOUT_SETTING

MAXIMUM_REINDEXING_TIMEOUT_SETTING

public static final Setting<TimeValue> MAXIMUM_REINDEXING_TIMEOUT_SETTING

Constructor Details

ShutdownPrepareService

public ShutdownPrepareService(Settings settings,
 HttpServerTransport httpServerTransport,
 TaskManager taskManager,
 TerminationHandler terminationHandler)

Method Details

addShutdownHook

public void addShutdownHook(String name,
 Runnable action)

isShuttingDown

public boolean isShuttingDown()

prepareForShutdown

public void prepareForShutdown()

Invokes hooks to prepare this node to be closed. This should be called when Elasticsearch receives a request to shut down gracefully from the underlying operating system, before system resources are closed. This method will block until the node is ready to shut down.

Note that this class is part of infrastructure to react to signals from the operating system - most graceful shutdown logic should use Node Shutdown, see NodesShutdownMetadata.