org.apache.ignite.internal.commandline

Class AbstractCommand<T>

java.lang.Object

org.apache.ignite.internal.commandline.AbstractCommand<T>

All Implemented Interfaces:

Command<T>

Direct Known Subclasses:

ActivateCommand, BaselineCommand, CacheCommands, CacheContention, CacheDestroy, CacheDistribution, CacheGroupEncryptionCommand, CacheIndexesForceRebuild, CacheIndexesList, CacheIndexesRebuildStatus, CacheValidateIndexes, CacheViewer, ChangeCacheGroupKeyCommand, ChangeMasterKeyCommand, CheckIndexInlineSizes, ClusterChangeTagCommand, ClusterStateChangeCommand, ConsistencyCommand, DeactivateCommand, DiagnosticCommand, EncryptionCommands, FindAndDeleteGarbage, GetMasterKeyNameCommand, IdleVerify, KillCommand, MetadataAbstractSubCommand, MetadataCommand, MetadataHelpCommand, MetricCommand, PageLocksCommand, PerformanceStatisticsCommand, PropertyAbstractSubCommand, PropertyCommand, ReencryptionRateCommand, ResetLostPartitions, ShutdownPolicyCommand, SnapshotCommand, SnapshotSubcommand, StateCommand, SystemViewCommand, TracingConfigurationCommand, TxCommands, WalCommands, WarmUpCommand

public abstract class AbstractCommand<T>
extends Object
implements Command<T>

Abstract class for control.sh commands, that support verbose mode.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	verbose Use verbose mode or not.

Constructor Summary

Constructors

Constructor and Description
AbstractCommand()

Method Summary

Modifier and Type	Method and Description
Object	execute(GridClientConfiguration clientCfg, Logger log, boolean verbose) Actual command execution with verbose mode if needed.
protected void	usageCache(Logger logger, CacheSubcommands cmd, String description, Map<String,String> paramsDesc, String... args) Print cache command usage with default indention.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.internal.commandline.Command

arg, confirmationPrompt, execute, experimental, extendToLen, name, parseArguments, prepareConfirmation, printUsage, startClient, startClientBeforeNodeStart, usage, usage, usageParams

Field Detail

verbose

protected boolean verbose

Use verbose mode or not.

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

execute

public Object execute(GridClientConfiguration clientCfg,
                      Logger log,
                      boolean verbose)
               throws Exception

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

Specified by:

execute in interface Command<T>

Parameters:

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

log - Logger to use.

verbose - Use verbose mode or not

Returns:

Result of operation (mostly usable for tests).

Throws:

Exception - If error occur.

See Also:

Command.execute(GridClientConfiguration, Logger)

usageCache

protected void usageCache(Logger logger,
                          CacheSubcommands cmd,
                          String description,
                          Map<String,String> paramsDesc,
                          String... args)

Print cache command usage with default indention.

Parameters:

logger - Logger to use.

cmd - Cache command.

description - Command description.

paramsDesc - Parameter desciptors.

args - Cache command arguments.