Package de.iip_ecosphere.platform.ecsRuntime

Enum Class ContainerState

java.lang.Object

java.lang.Enum<ContainerState>

de.iip_ecosphere.platform.ecsRuntime.ContainerState

All Implemented Interfaces:

Serializable, Comparable<ContainerState>, Constable

public enum ContainerState
extends Enum<ContainerState>

Defines container states.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVAILABLE	The container is on the device and ready to be deployed.
DEPLOYED	The container is running.
DEPLOYING	The container is brought to life.
FAILED	The container failed for some reason.
MIGRATING	The container is not operating as it is about or in the process of being migrated.
STOPPED	The container was stopped and may be disposed or started again.
STOPPING	The container is going out of operation.
UNDEPLOYING	The container is about to be removed from this resource.
UNKNOWN	The state of the container is not known.
UPDATING	The container is not operating as it is being updated with a more recent version.

Field Summary

Fields

Modifier and Type	Field	Description
private static Map<ContainerState,Set<ContainerState>>	validTransitions

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ContainerState()

Method Summary

Modifier and Type	Method	Description
private static void	addValidTransition(ContainerState source, ContainerState... targets)	Adds a valid transition.
boolean	isValidTransition(ContainerState target)	Returns whether a transition from this state to target is valid.
static void	validateTransition(ContainerState source, ContainerState target)	Validates a container state transition and throws an exception if the transition is invalid.
static ContainerState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContainerState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AVAILABLE

public static final ContainerState AVAILABLE

The container is on the device and ready to be deployed. Next state shall be DEPLOYING.

DEPLOYING

public static final ContainerState DEPLOYING

The container is brought to life. Next state shall be DEPLOYED.

DEPLOYED

public static final ContainerState DEPLOYED

The container is running. Next state may be FAILED, MIGRATING, UPDATING or STOPPING.

FAILED

public static final ContainerState FAILED

The container failed for some reason. Next state may be DEPLOYED, MIGRATING, UPDATING or STOPPING.

MIGRATING

public static final ContainerState MIGRATING

The container is not operating as it is about or in the process of being migrated. Next state may be DEPLOYED, FAILED or STOPPING.

UPDATING

public static final ContainerState UPDATING

The container is not operating as it is being updated with a more recent version. Next state may be DEPLOYED, FAILED or STOPPING.

STOPPING

public static final ContainerState STOPPING

The container is going out of operation. Next state shall be STOPPED.

STOPPED

public static final ContainerState STOPPED

The container was stopped and may be disposed or started again. Next state may be UNDEPLOYING or UNDEPLOYING.

UNDEPLOYING

public static final ContainerState UNDEPLOYING

The container is about to be removed from this resource. Next state may be UNKNOWN.

UNKNOWN

public static final ContainerState UNKNOWN

The state of the container is not known.

Field Details

validTransitions

private static Map<ContainerState,Set<ContainerState>> validTransitions

Constructor Details

ContainerState

private ContainerState()

Method Details

values

public static ContainerState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ContainerState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

addValidTransition

private static void addValidTransition(ContainerState source,
 ContainerState... targets)

Adds a valid transition. Transitions to FAILED or UNKNOWN are implicitly valid.

Parameters:

source - the source state to transition from

targets - the target state(s) to transition to

isValidTransition

public boolean isValidTransition(ContainerState target)

Returns whether a transition from this state to target is valid.

Parameters:

target - the target state

Returns:

true for valid, false else

validateTransition

public static void validateTransition(ContainerState source,
 ContainerState target)
                               throws ExecutionException

Validates a container state transition and throws an exception if the transition is invalid.

Parameters:

source - the source state

target - the target state

Throws:

ExecutionException - if source is null or a transition from source to target is not valid