Package org.opensearch.cluster.coordination

Class OpenSearchNodeCommand

java.lang.Object

org.opensearch.cli.Command

org.opensearch.cli.EnvironmentAwareCommand

org.opensearch.cluster.coordination.OpenSearchNodeCommand

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

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

public abstract class OpenSearchNodeCommand
extends EnvironmentAwareCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenSearchNodeCommand.UnknownCondition
static class	OpenSearchNodeCommand.UnknownMetadataCustom

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ABORTED_BY_USER_MSG
protected static java.lang.String	CS_MISSING_MSG
protected static java.lang.String	DELIMITER
protected static java.lang.String	FAILED_TO_OBTAIN_NODE_LOCK_MSG
static org.opensearch.common.xcontent.NamedXContentRegistry	namedXContentRegistry

Fields inherited from class org.opensearch.cli.Command

description, parser

Constructor Summary

Constructors

Constructor	Description
OpenSearchNodeCommand(java.lang.String description)

Method Summary

Modifier and Type	Method	Description
static ClusterState	clusterState(Environment environment, PersistedClusterStateService.OnDiskState onDiskState)
protected void	confirm(org.opensearch.cli.Terminal terminal, java.lang.String msg)
static PersistedClusterStateService	createPersistedClusterStateService(Settings settings, java.nio.file.Path[] dataPaths)
void	execute(org.opensearch.cli.Terminal terminal, joptsimple.OptionSet options, Environment env)	Execute the command with the initialized Environment.
static org.opensearch.common.collect.Tuple<java.lang.Long,ClusterState>	loadTermAndClusterState(PersistedClusterStateService psf, Environment env)
protected abstract void	processNodePaths(org.opensearch.cli.Terminal terminal, java.nio.file.Path[] dataPaths, int nodeLockId, joptsimple.OptionSet options, Environment env)	Process the paths.
protected void	processNodePaths(org.opensearch.cli.Terminal terminal, joptsimple.OptionSet options, Environment env)
protected NodeEnvironment.NodePath[]	toNodePaths(java.nio.file.Path[] dataPaths)
protected boolean	validateBeforeLock(org.opensearch.cli.Terminal terminal, Environment env)	Validate that the command can run before taking any locks.

Methods inherited from class org.opensearch.cli.EnvironmentAwareCommand

createEnv, createEnv, execute

Methods inherited from class org.opensearch.cli.Command

addShutdownHook, close, exit, main, printAdditionalHelp

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

protected static final java.lang.String DELIMITER

See Also:

Constant Field Values

FAILED_TO_OBTAIN_NODE_LOCK_MSG

protected static final java.lang.String FAILED_TO_OBTAIN_NODE_LOCK_MSG

See Also:

Constant Field Values

ABORTED_BY_USER_MSG

protected static final java.lang.String ABORTED_BY_USER_MSG

See Also:

Constant Field Values

CS_MISSING_MSG

protected static final java.lang.String CS_MISSING_MSG

See Also:

Constant Field Values

namedXContentRegistry

public static final org.opensearch.common.xcontent.NamedXContentRegistry namedXContentRegistry

Constructor Details

OpenSearchNodeCommand

public OpenSearchNodeCommand(java.lang.String description)

Method Details

createPersistedClusterStateService

public static PersistedClusterStateService createPersistedClusterStateService(Settings settings, java.nio.file.Path[] dataPaths) throws java.io.IOException

Throws:

java.io.IOException

clusterState

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

loadTermAndClusterState

public static org.opensearch.common.collect.Tuple<java.lang.Long,ClusterState> loadTermAndClusterState(PersistedClusterStateService psf, Environment env) throws java.io.IOException

Throws:

java.io.IOException

processNodePaths

protected void processNodePaths(org.opensearch.cli.Terminal terminal, joptsimple.OptionSet options, Environment env) throws java.io.IOException, org.opensearch.cli.UserException

Throws:

java.io.IOException

org.opensearch.cli.UserException

confirm

protected void confirm(org.opensearch.cli.Terminal terminal, java.lang.String msg)

execute

public final void execute(org.opensearch.cli.Terminal terminal, joptsimple.OptionSet options, Environment env) throws java.lang.Exception

Description copied from class: EnvironmentAwareCommand

Execute the command with the initialized Environment.

Specified by:

execute in class EnvironmentAwareCommand

Throws:

java.lang.Exception

validateBeforeLock

protected boolean validateBeforeLock(org.opensearch.cli.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).

processNodePaths

protected abstract void processNodePaths(org.opensearch.cli.Terminal terminal, java.nio.file.Path[] dataPaths, int nodeLockId, joptsimple.OptionSet options, Environment env) throws java.io.IOException, org.opensearch.cli.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:

java.io.IOException

org.opensearch.cli.UserException

toNodePaths

protected NodeEnvironment.NodePath[] toNodePaths(java.nio.file.Path[] dataPaths)