Module org.elasticsearch.server

Package org.elasticsearch.cluster.coordination

Class ElasticsearchNodeCommand

java.lang.Object

org.elasticsearch.cli.Command

org.elasticsearch.common.cli.EnvironmentAwareCommand

org.elasticsearch.cluster.coordination.ElasticsearchNodeCommand

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DetachClusterCommand, NodeRepurposeCommand, OverrideNodeVersionCommand, RemoveCorruptedShardDataCommand, RemoveCustomsCommand, RemoveIndexSettingsCommand, RemoveSettingsCommand, UnsafeBootstrapMasterCommand

public abstract class ElasticsearchNodeCommand
extends EnvironmentAwareCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticsearchNodeCommand.UnknownCondition
static final record	ElasticsearchNodeCommand.UnknownMetadataCustom

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ABORTED_BY_USER_MSG
protected static final String	CS_MISSING_MSG
protected static final String	DELIMITER
protected static final String	FAILED_TO_OBTAIN_NODE_LOCK_MSG
static final NamedXContentRegistry	namedXContentRegistry

Fields inherited from class org.elasticsearch.cli.Command

description, parser

Constructor Summary

Constructors

Constructor	Description
ElasticsearchNodeCommand(String description)

Method Summary

Modifier and Type	Method	Description
static ClusterState	clusterState(Environment environment, PersistedClusterStateService.OnDiskState onDiskState)
protected static void	confirm(Terminal terminal, String msg)
static PersistedClusterStateService	createPersistedClusterStateService(Settings settings, Path[] dataPaths)
final void	execute(Terminal terminal, joptsimple.OptionSet options, Environment env, ProcessInfo processInfo)	Execute the command with the initialized Environment.
static Tuple<Long,ClusterState>	loadTermAndClusterState(PersistedClusterStateService psf, Environment env)
protected abstract void	processDataPaths(Terminal terminal, Path[] dataPaths, joptsimple.OptionSet options, Environment env)	Process the paths.
protected void	processDataPaths(Terminal terminal, joptsimple.OptionSet options, Environment env)
protected static NodeEnvironment.DataPath[]	toDataPaths(Path[] paths)
protected boolean	validateBeforeLock(Terminal terminal, Environment env)	Validate that the command can run before taking any locks.

Methods inherited from class org.elasticsearch.common.cli.EnvironmentAwareCommand

createEnv, execute, getBuildType

Methods inherited from class org.elasticsearch.cli.Command

close, exit, main, mainWithoutErrorHandling, parseOptions, printAdditionalHelp, printUserException

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

protected static final String DELIMITER

See Also:

• Constant Field Values

FAILED_TO_OBTAIN_NODE_LOCK_MSG

protected static final String FAILED_TO_OBTAIN_NODE_LOCK_MSG

See Also:

• Constant Field Values

ABORTED_BY_USER_MSG

protected static final String ABORTED_BY_USER_MSG

See Also:

• Constant Field Values

CS_MISSING_MSG

protected static final String CS_MISSING_MSG

See Also:

• Constant Field Values

namedXContentRegistry

public static final NamedXContentRegistry namedXContentRegistry

Constructor Details

ElasticsearchNodeCommand

public ElasticsearchNodeCommand(String description)

Method Details

createPersistedClusterStateService

public static PersistedClusterStateService createPersistedClusterStateService(Settings settings,
 Path[] dataPaths)
                                                                       throws IOException

Throws:

IOException

clusterState

public static ClusterState clusterState(Environment environment,
 PersistedClusterStateService.OnDiskState onDiskState)

loadTermAndClusterState

public static Tuple<Long,ClusterState> loadTermAndClusterState(PersistedClusterStateService psf,
 Environment env)
                                                        throws IOException

Throws:

IOException

processDataPaths

protected void processDataPaths(Terminal terminal,
 joptsimple.OptionSet options,
 Environment env)
                         throws IOException,
UserException

Throws:

IOException

UserException

confirm

protected static void confirm(Terminal terminal,
 String msg)

execute

public final void execute(Terminal terminal,
 joptsimple.OptionSet options,
 Environment env,
 ProcessInfo processInfo)
                   throws Exception

Description copied from class: EnvironmentAwareCommand

Execute the command with the initialized Environment.

Specified by:

execute in class EnvironmentAwareCommand

Throws:

Exception

validateBeforeLock

protected boolean validateBeforeLock(Terminal terminal,
 Environment env)

Validate that the command can run before taking any locks.

Parameters:

terminal - the terminal to print to

env - the env to validate.

Returns:

true to continue, false to stop (must print message in validate).

processDataPaths

protected abstract void processDataPaths(Terminal terminal,
 Path[] dataPaths,
 joptsimple.OptionSet options,
 Environment env)
                                  throws IOException,
UserException

Process the paths. Locks for the paths is held during this method invocation.

Parameters:

terminal - the terminal to use for messages

dataPaths - the paths of the node to process

options - the command line options

env - the env of the node to process

Throws:

IOException

UserException

toDataPaths

protected static NodeEnvironment.DataPath[] toDataPaths(Path[] paths)