org.apache.ignite.internal.commandline.property.subcommands

Class PropertyAbstractSubCommand<MetadataArgsDto extends IgniteDataTransferObject,MetadataResultDto extends IgniteDataTransferObject>

java.lang.Object

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

org.apache.ignite.internal.commandline.property.subcommands.PropertyAbstractSubCommand<MetadataArgsDto,MetadataResultDto>

All Implemented Interfaces:

Command<MetadataArgsDto>

Direct Known Subclasses:

PropertyGetCommand, PropertyListCommand, PropertySetCommand

public abstract class PropertyAbstractSubCommand<MetadataArgsDto extends IgniteDataTransferObject,MetadataResultDto extends IgniteDataTransferObject>
extends AbstractCommand<MetadataArgsDto>

Field Summary

Fields inherited from class org.apache.ignite.internal.commandline.AbstractCommand

verbose

Constructor Summary

Constructors

Constructor and Description
PropertyAbstractSubCommand()

Method Summary

Modifier and Type	Method and Description
MetadataArgsDto	arg()
protected boolean	changesClusterState() Whether the subcommand changes state shared by the whole cluster.
Object	execute(GridClientConfiguration clientCfg, Logger log) Actual command execution.
void	parseArguments(CommandArgIterator argIter) Parse command-specific arguments.
protected MetadataArgsDto	parseArguments0(CommandArgIterator argIter)
protected abstract void	printResult(MetadataResultDto res, Logger log)
void	printUsage(Logger log) Print info for user about command (parameters, use cases and so on).
protected abstract String	taskName()

Methods inherited from class org.apache.ignite.internal.commandline.AbstractCommand

execute

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

confirmationPrompt, experimental, experimentalEnabled, extendToLen, name, prepareConfirmation, startClient, startClientBeforeNodeStart, usage, usage, usageParams

Constructor Detail

PropertyAbstractSubCommand

public PropertyAbstractSubCommand()

Method Detail

printUsage

public final void printUsage(Logger log)

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

Parameters:

log - Logger to use.

parseArguments

public final void parseArguments(CommandArgIterator argIter)

Parse command-specific arguments.

Parameters:

argIter - Argument iterator.

execute

public final Object execute(GridClientConfiguration clientCfg,
                            Logger log)
                     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.

log - Logger to use.

Returns:

Result of operation (mostly usable for tests).

Throws:

Exception - If error occur.

arg

public final MetadataArgsDto arg()

Returns:

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

changesClusterState

protected boolean changesClusterState()

Whether the subcommand changes state shared by the whole cluster. Such a subcommand is refused on a node in maintenance mode, which is detached from the cluster.

Returns:

True if the subcommand changes cluster wide state.

taskName

protected abstract String taskName()

parseArguments0

protected MetadataArgsDto parseArguments0(CommandArgIterator argIter)

printResult

protected abstract void printResult(MetadataResultDto res,
                                    Logger log)