org.apache.ignite.internal.commandline

Interface Command<T>

Type Parameters:

T - Generic for getArg method which should return command-specific paramters which it would be run with.

All Known Implementing Classes:

AbstractCommand, ActivateCommand, BaselineCommand, CacheCommands, CacheContention, CacheDestroy, CacheDistribution, CacheGroupEncryptionCommand, CacheGroupEncryptionCommand.CacheKeyIds, CacheGroupEncryptionCommand.ReencryptionStatus, CacheGroupEncryptionCommand.ResumeReencryption, CacheGroupEncryptionCommand.SuspendReencryption, CacheIndexesForceRebuild, CacheIndexesList, CacheIndexesRebuildStatus, CacheValidateIndexes, CacheViewer, ChangeCacheGroupKeyCommand, ChangeMasterKeyCommand, CheckIndexInlineSizes, ClusterChangeTagCommand, ClusterStateChangeCommand, ConnectivityCommand, ConsistencyCommand, DeactivateCommand, DefragmentationCommand, DiagnosticCommand, EncryptionCommands, FindAndDeleteGarbage, GetMasterKeyNameCommand, IdleVerify, KillCommand, MetadataAbstractSubCommand, MetadataCommand, MetadataDetailsCommand, MetadataHelpCommand, MetadataListCommand, MetadataRemoveCommand, MetadataUpdateCommand, MetricCommand, PageLocksCommand, PerformanceStatisticsCommand, PersistenceCommand, PropertyAbstractSubCommand, PropertyCommand, PropertyGetCommand, PropertyHelpCommand, PropertyListCommand, PropertySetCommand, ReencryptionRateCommand, ResetLostPartitions, ShutdownPolicyCommand, SnapshotCancelCommand, SnapshotCheckCommand, SnapshotCommand, SnapshotCreateCommand, SnapshotRestoreCommand, SnapshotSubcommand, StateCommand, SystemViewCommand, TracingConfigurationCommand, TxCommands, WalCommands, WarmUpCommand

public interface Command<T>

Abstract class for all control.sh commands, has already implemented methods and abstract methods. Define flow how to work with command.

Method Summary

Modifier and Type	Method and Description
T	arg()
default String	confirmationPrompt()
Object	execute(GridClientConfiguration clientCfg, Logger logger) Actual command execution.
default Object	execute(GridClientConfiguration clientCfg, Logger logger, boolean verbose) Actual command execution with verbose mode if needed.
default boolean	experimental() Return true if the command is experimental or false otherwise.
static String	extendToLen(String s, int targetLen) Appends spaces to end of input string for extending to needed length.
String	name()
default void	parseArguments(CommandArgIterator argIterator) Parse command-specific arguments.
default void	prepareConfirmation(GridClientConfiguration clientCfg) Prepares confirmation for the command.
void	printUsage(Logger logger) Print info for user about command (parameters, use cases and so on).
static GridClient	startClient(GridClientConfiguration clientCfg) Method to create thin client for communication with cluster.
static GridClientBeforeNodeStart	startClientBeforeNodeStart(GridClientConfiguration clientCfg) Method to create thin client for communication with node before it starts.
default void	usage(Logger logger, String desc, CommandList cmd, @Nullable Map<String,String> paramsDesc, String... args) Print command usage.
default void	usage(Logger logger, String desc, CommandList cmd, String... args) Print command usage.
default void	usageParams(Map<String,String> paramsDesc, String indent, Logger logger) Print cache command arguments usage.

Method Detail

startClient

static GridClient startClient(GridClientConfiguration clientCfg)
                       throws Exception

Method to create thin client for communication with cluster.

Parameters:

clientCfg - Thin client configuration.

Returns:

Grid thin client instance which is already connected to cluster.

Throws:

Exception - If error occur.

startClientBeforeNodeStart

static GridClientBeforeNodeStart startClientBeforeNodeStart(GridClientConfiguration clientCfg)
                                                     throws Exception

Method to create thin client for communication with node before it starts. If node has already started, there will be an error.

Parameters:

clientCfg - Thin client configuration.

Returns:

Grid thin client instance which is already connected to node before it starts.

Throws:

Exception - If error occur.

usage

default void usage(Logger logger,
                   String desc,
                   CommandList cmd,
                   String... args)

Print command usage.

Parameters:

logger - Logger to use.

desc - Command description.

cmd - Command.

args - Arguments.

usage

default void usage(Logger logger,
                   String desc,
                   CommandList cmd,
                   @Nullable
                   @Nullable Map<String,String> paramsDesc,
                   String... args)

Print command usage.

Parameters:

logger - Logger to use.

desc - Command description.

cmd - Command.

paramsDesc - Description of parameters (optional).

args - Arguments.

usageParams

default void usageParams(Map<String,String> paramsDesc,
                         String indent,
                         Logger logger)

Print cache command arguments usage.

Parameters:

paramsDesc - Cache command arguments description.

indent - Indent string.

logger - Logger to use.

extendToLen

static String extendToLen(String s,
                          int targetLen)

Appends spaces to end of input string for extending to needed length.

Parameters:

s - Input string.

targetLen - Needed length.

Returns:

String with appended spaces on the end.

execute

Object execute(GridClientConfiguration clientCfg,
               Logger logger)
        throws Exception

Actual command execution. Parameters for run should be already set by calling parseArguments method.

Parameters:

clientCfg - Thin client configuration if connection to cluster is necessary.

logger - Logger to use.

Returns:

Result of operation (mostly usable for tests).

Throws:

Exception - If error occur.

execute

default Object execute(GridClientConfiguration clientCfg,
                       Logger logger,
                       boolean verbose)
                throws Exception

Actual command execution with verbose mode if needed. Implement it if your command supports verbose mode.

Parameters:

clientCfg - Thin client configuration if connection to cluster is necessary.

logger - Logger to use.

verbose - Use verbose mode or not

Returns:

Result of operation (mostly usable for tests).

Throws:

Exception - If error occur.

See Also:

execute(GridClientConfiguration, Logger)

prepareConfirmation

default void prepareConfirmation(GridClientConfiguration clientCfg)
                          throws Exception

Prepares confirmation for the command.

Parameters:

clientCfg - Thin client configuration.

Throws:

Exception - If error occur.

confirmationPrompt

default String confirmationPrompt()

Returns:

Message text to show user for. If null it means that confirmantion is not needed.

parseArguments

default void parseArguments(CommandArgIterator argIterator)

Parse command-specific arguments.

Parameters:

argIterator - Argument iterator.

arg

T arg()

Returns:

Command arguments which were parsed during parseArguments(CommandArgIterator) call.

printUsage

void printUsage(Logger logger)

Print info for user about command (parameters, use cases and so on).

Parameters:

logger - Logger to use.

name

String name()

Returns:

command name.

experimental

default boolean experimental()

Return true if the command is experimental or false otherwise.

Returns:

true if the command is experimental or false otherwise.