org.apache.ambari.server.state

Enum State

java.lang.Object

java.lang.Enum<State>

org.apache.ambari.server.state.State

All Implemented Interfaces:

Serializable, Comparable<State>

public enum State
extends Enum<State>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Disabled master's backup state
INIT Initial/Clean state.
INSTALL_FAILED Install failed.
INSTALLED State when install completed successfully.
INSTALLING In the process of installing.
STARTED State when start completed successfully.
STARTING In the process of starting.
STOPPING In the process of stopping.
UNINSTALLED State when uninstall completed successfully.
UNINSTALLING In the process of uninstalling.
UNKNOWN State could not be determined.
UPGRADING In the process of upgrading the host component deployed bits.
WIPING_OUT In the process of wiping out the install.

Method Summary

Modifier and Type	Method and Description
static void	checkUpdateConfiguration(ServiceComponentHost serviceComponentHost, State currentState, State desiredState) Determine whether or not it is safe to update the configuration of the given service component host for the given states.
boolean	isRemovableState() Indicates whether or not the resource with this state can be removed.
boolean	isValidClientComponentState() Indicates whether or not it is a valid state for the client component.
boolean	isValidDesiredState() Indicates whether or not it is a valid desired state.
static boolean	isValidDesiredStateTransition(State startState, State desiredState) Utility method to determine whether or not the given desired state is valid for the given starting state.
static boolean	isValidStateTransition(State startState, State desiredState) Utility method to determine whether or not a valid transition can be made from the given states.
static State	valueOf(String name) Returns the enum constant of this type with the specified name.
static State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INIT

public static final State INIT

Initial/Clean state.

INSTALLING

public static final State INSTALLING

In the process of installing.

INSTALL_FAILED

public static final State INSTALL_FAILED

Install failed.

INSTALLED

public static final State INSTALLED

State when install completed successfully.

STARTING

public static final State STARTING

In the process of starting.

STARTED

public static final State STARTED

State when start completed successfully.

STOPPING

public static final State STOPPING

In the process of stopping.

UNINSTALLING

public static final State UNINSTALLING

In the process of uninstalling.

UNINSTALLED

public static final State UNINSTALLED

State when uninstall completed successfully.

WIPING_OUT

public static final State WIPING_OUT

In the process of wiping out the install.

UPGRADING

public static final State UPGRADING

In the process of upgrading the host component deployed bits. Valid only for host component state

DISABLED

public static final State DISABLED

Disabled master's backup state

UNKNOWN

public static final State UNKNOWN

State could not be determined.

Method Detail

values

public static State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (State c : State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isValidDesiredState

public boolean isValidDesiredState()

Indicates whether or not it is a valid desired state.

Returns:

true if this is a valid desired state.

isValidClientComponentState

public boolean isValidClientComponentState()

Indicates whether or not it is a valid state for the client component.

Returns:

true if this is a valid state for a client component.

isRemovableState

public boolean isRemovableState()

Indicates whether or not the resource with this state can be removed.

Returns:

true if this is a removable state

isValidStateTransition

public static boolean isValidStateTransition(State startState,
                                             State desiredState)

Utility method to determine whether or not a valid transition can be made from the given states.

Parameters:

startState - the starting state

desiredState - the desired state

Returns:

true iff a valid transition can be made from the starting state to the desired state

isValidDesiredStateTransition

public static boolean isValidDesiredStateTransition(State startState,
                                                    State desiredState)

Utility method to determine whether or not the given desired state is valid for the given starting state.

Parameters:

startState - the starting state

desiredState - the desired state

Returns:

true iff the given desired state is valid for the given starting state

checkUpdateConfiguration

public static void checkUpdateConfiguration(ServiceComponentHost serviceComponentHost,
                                            State currentState,
                                            State desiredState)
                                     throws org.apache.ambari.server.AmbariException

Determine whether or not it is safe to update the configuration of the given service component host for the given states.

Parameters:

serviceComponentHost - the service component host

currentState - the current state

desiredState - the desired state

Throws:

org.apache.ambari.server.AmbariException - if the changing of configuration is not supported