org.apache.ignite.internal.commandline.cache

Class CacheDestroy

java.lang.Object

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

org.apache.ignite.internal.commandline.cache.CacheDestroy

All Implemented Interfaces:

Command<VisorCacheStopTaskArg>

public class CacheDestroy
extends AbstractCommand<VisorCacheStopTaskArg>

Cache destroy command.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_NAMES_ARG Command argument to specify a comma-separated list of cache names to be destroyed.
static String	CONFIRM_MSG Confirmation message format.
static String	DESTROY_ALL_ARG Command argument to destroy all user-created caches.
static String	NOOP_MSG No user-created caches exists message.
static String	RESULT_MSG Result message.

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

verbose

Constructor Summary

Constructors

Constructor and Description
CacheDestroy()

Method Summary

Modifier and Type	Method and Description
VisorCacheStopTaskArg	arg()
String	confirmationPrompt()
Object	execute(GridClientConfiguration clientCfg, Logger log) 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 log) Print info for user about command (parameters, use cases and so on).

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

execute, usageCache

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, extendToLen, startClient, startClientBeforeNodeStart, usage, usage, usageParams

Field Detail

DESTROY_ALL_ARG

public static final String DESTROY_ALL_ARG

Command argument to destroy all user-created caches.

See Also:

Constant Field Values

CACHE_NAMES_ARG

public static final String CACHE_NAMES_ARG

Command argument to specify a comma-separated list of cache names to be destroyed.

See Also:

Constant Field Values

CONFIRM_MSG

public static final String CONFIRM_MSG

Confirmation message format.

See Also:

Constant Field Values

NOOP_MSG

public static final String NOOP_MSG

No user-created caches exists message.

See Also:

Constant Field Values

RESULT_MSG

public static final String RESULT_MSG

Result message.

See Also:

Constant Field Values

Constructor Detail

CacheDestroy

public CacheDestroy()

Method Detail

arg

public VisorCacheStopTaskArg arg()

Returns:

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

printUsage

public void printUsage(Logger log)

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

Parameters:

log - Logger to use.

parseArguments

public void parseArguments(CommandArgIterator argIter)

Parse command-specific arguments.

Parameters:

argIter - Argument iterator.

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 confirmantion is not needed.

execute

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

name

public String name()

Returns:

command name.