Package org.apache.ignite.internal.management

Class SetStateCommand

java.lang.Object

org.apache.ignite.internal.management.SetStateCommand

All Implemented Interfaces:

Command<SetStateCommandArg,Boolean>, LocalCommand<SetStateCommandArg,Boolean>

public class SetStateCommand
extends Object
implements LocalCommand<SetStateCommandArg,Boolean>

Field Summary

Fields inherited from interface org.apache.ignite.internal.management.api.Command

CMD_NAME_POSTFIX

Constructor Summary

Constructors

Constructor	Description
SetStateCommand()

Method Summary

Modifier and Type	Method	Description
Class<SetStateCommandArg>	argClass()
String	confirmationPrompt(SetStateCommandArg arg)
String	description()	Command description.
Boolean	execute(@Nullable GridClient cli, @Nullable IgniteClient client, @Nullable Ignite ignite, SetStateCommandArg arg, Consumer<String> printer)	Executes command logic.

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.management.api.Command

deprecationMessage

Constructor Detail

SetStateCommand

public SetStateCommand()

Method Detail

description

public String description()

Command description.

Specified by:

description in interface Command<SetStateCommandArg,Boolean>

argClass

public Class<SetStateCommandArg> argClass()

Specified by:

argClass in interface Command<SetStateCommandArg,Boolean>

Returns:

Arguments class.

execute

public Boolean execute(@Nullable
                       @Nullable GridClient cli,
                       @Nullable
                       @Nullable IgniteClient client,
                       @Nullable
                       @Nullable Ignite ignite,
                       SetStateCommandArg arg,
                       Consumer<String> printer)
                throws GridClientException

Executes command logic. Commands invoked in two different environments:

• CLI utility using GridClient connection to interact with cluster.
• Inside Ignite node therefore local node can be used to interact with cluster.

Please, keep in mind that GridClient protocol is obsolete and can be removed in future releases.

Specified by:

execute in interface LocalCommand<SetStateCommandArg,Boolean>

Parameters:

cli - Optional grid client instance.

ignite - Optional ignite node.

arg - Command argument.

printer - Results printer.

Returns:

Command result.

Throws:

GridClientException

confirmationPrompt

public String confirmationPrompt(SetStateCommandArg arg)

Specified by:

confirmationPrompt in interface Command<SetStateCommandArg,Boolean>

Parameters:

arg - Command argument.

Returns:

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