org.apache.ignite.internal.commandline.cache

Class CacheCommands

java.lang.Object

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

org.apache.ignite.internal.commandline.cache.CacheCommands

All Implemented Interfaces:

Command<CacheSubcommands>

public class CacheCommands
extends AbstractCommand<CacheSubcommands>

High-level "cache" command implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_GROUP_NAME Empty group name.
protected static String	NODE_ID
protected static String	OP_NODE_ID

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

verbose

Constructor Summary

Constructors

Constructor and Description
CacheCommands()

Method Summary

Modifier and Type	Method and Description
CacheSubcommands	arg()
String	confirmationPrompt()
Object	execute(GridClientConfiguration clientCfg, Logger logger) Actual command execution.
String	name()
void	parseArguments(CommandArgIterator argIter) Parse command-specific arguments.
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).
protected static 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 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

experimental, experimentalEnabled, extendToLen, startClient, startClientBeforeNodeStart, usage, usage, usageParams

Field Detail

EMPTY_GROUP_NAME

public static final String EMPTY_GROUP_NAME

Empty group name.

See Also:

Constant Field Values

NODE_ID

protected static final String NODE_ID

See Also:

Constant Field Values

OP_NODE_ID

protected static final String OP_NODE_ID

Constructor Detail

CacheCommands

public CacheCommands()

Method Detail

printUsage

public void printUsage(Logger logger)

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

Parameters:

logger - Logger to use.

execute

public 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.

parseArguments

public void parseArguments(CommandArgIterator argIter)

Parse command-specific arguments.

Parameters:

argIter - Argument iterator.

usageCache

protected static 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.

prepareConfirmation

public void prepareConfirmation(GridClientConfiguration clientCfg)
                         throws Exception

Prepares confirmation for the command.

Parameters:

clientCfg - Thin client configuration.

Throws:

Exception - If error occur.

confirmationPrompt

public String confirmationPrompt()

Returns:

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

arg

public CacheSubcommands arg()

Returns:

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

name

public String name()

Returns:

command name.