org.apache.ignite.internal.commandline.util

Class MaintenanceModeUtils

java.lang.Object

org.apache.ignite.internal.commandline.util.MaintenanceModeUtils

public final class MaintenanceModeUtils
extends Object

Class provides utility methods to detect and report a node that runs in maintenance mode.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_REFUSED_MSG Explains why the command is refused.
static String	DETACHED_NODE_MSG Explains why the utility cannot show cluster-wide information.
static String	MAINTENANCE_MODE_DOC_URL Documentation on maintenance mode.

Method Summary

Modifier and Type	Method and Description
static void	failIfInMaintenanceMode(GridClient client, Logger logger) Refuses to execute a command that needs the cluster if the client is connected to a node in maintenance mode.
static @Nullable GridClientNode	maintenanceModeNode(GridClient client) Obtains the node in maintenance mode the client is connected to.
static void	printMaintenanceModeWarning(GridClientNode node, Logger logger) Prints the warning that the given node runs in maintenance mode.
static void	warnIfInMaintenanceMode(GridClient client, Logger logger) Warns if the client is connected to a node in maintenance mode.

Methods inherited from class java.lang.Object

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

Field Detail

MAINTENANCE_MODE_DOC_URL

public static final String MAINTENANCE_MODE_DOC_URL

Documentation on maintenance mode.

See Also:

Constant Field Values

DETACHED_NODE_MSG

public static final String DETACHED_NODE_MSG

Explains why the utility cannot show cluster-wide information.

See Also:

Constant Field Values

COMMAND_REFUSED_MSG

public static final String COMMAND_REFUSED_MSG

Explains why the command is refused.

See Also:

Constant Field Values

Method Detail

maintenanceModeNode

@Nullable
public static @Nullable GridClientNode maintenanceModeNode(GridClient client)
                                                              throws GridClientException

Obtains the node in maintenance mode the client is connected to.

Parameters:

client - Client connected to the node.

Returns:

Node in maintenance mode or null if there is none.

Throws:

GridClientException - If client doesn't have an actual topology version.

warnIfInMaintenanceMode

public static void warnIfInMaintenanceMode(GridClient client,
                                           Logger logger)
                                    throws GridClientException

Warns if the client is connected to a node in maintenance mode.

Parameters:

client - Client connected to the node.

logger - Logger to print the warning to.

Throws:

GridClientException - If client doesn't have an actual topology version.

failIfInMaintenanceMode

public static void failIfInMaintenanceMode(GridClient client,
                                           Logger logger)
                                    throws GridClientException

Refuses to execute a command that needs the cluster if the client is connected to a node in maintenance mode.

Parameters:

client - Client connected to the node.

logger - Logger to print the warning to.

Throws:

GridClientException - If client doesn't have an actual topology version.

VisorIllegalStateException - If the node the client is connected to is in maintenance mode.

printMaintenanceModeWarning

public static void printMaintenanceModeWarning(GridClientNode node,
                                               Logger logger)

Prints the warning that the given node runs in maintenance mode.

Parameters:

node - Node in maintenance mode.

logger - Logger to print the warning to.