com.ibm.websphere.objectgrid.plugins
Enum ObjectGridLifecycleListener.State

java.lang.Object
  java.lang.Enum<ObjectGridLifecycleListener.State>
      com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener.State

All Implemented Interfaces:

Serializable, Comparable<ObjectGridLifecycleListener.State>

Enclosing interface:

ObjectGridLifecycleListener

public static enum ObjectGridLifecycleListener.State
extends Enum<ObjectGridLifecycleListener.State>

The state of a ObjectGrid's life cycle.

Enum Constant Summary

DESTROYED
The ObjectGrid instance, its BackingMap instances and all ObjectGrid plug-ins have been destroyed.

DESTROYING
The ObjectGrid instance is starting the destroy phase.

INITIALIZED
The ObjectGrid initialization phase is complete.

INITIALIZING
The ObjectGrid initialization phase is starting.

NEW
The ObjectGrid instance has been created.

OFFLINE
All work is stopped on the ObjectGrid as a result of the StateManager API or other event.

ONLINE
The ObjectGrid instance is ready for work as a local instance, client instance or as an instance in a primary or replica shard on the server.

PRELOAD
The ObjectGrid instance is set to the PRELOAD state by the StateManager API or other configuration.

QUIESCE
Work is stopping on the ObjectGrid as a result of the StateManager API or other event.

STARTING
The ObjectGrid instance is being activated for use as a local instance, client instance or as an instance in a primary or replica shard on the server.

Method Summary

static ObjectGridLifecycleListener.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static ObjectGridLifecycleListener.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

NEW

public static final ObjectGridLifecycleListener.State NEW

The ObjectGrid instance has been created.

INITIALIZING

public static final ObjectGridLifecycleListener.State INITIALIZING

The ObjectGrid initialization phase is starting. The ObjectGrid and ObjectGrid plug-ins are about to be initialized. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the ObjectGrid.

INITIALIZED

public static final ObjectGridLifecycleListener.State INITIALIZED

The ObjectGrid initialization phase is complete. All ObjectGrid plug-ins are initialized. The INITIALIZED state may re-occur when shard placement activities (promotion, demotion) occur. All BackingMap plug-ins in the BackingMap instances owned by this ObjectGrid instance have been initialized. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the ObjectGrid.

STARTING

public static final ObjectGridLifecycleListener.State STARTING

The ObjectGrid instance is being activated for use as a local instance, client instance or as an instance in a primary or replica shard on the server. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the ObjectGrid.

PRELOAD

public static final ObjectGridLifecycleListener.State PRELOAD

The ObjectGrid instance is set to the PRELOAD state by the StateManager API or other configuration. A LifecycleFailedException sent during this state transition will result in an abort of the state change and destruction of the ObjectGrid.

ONLINE

public static final ObjectGridLifecycleListener.State ONLINE

The ObjectGrid instance is ready for work as a local instance, client instance or as an instance in a primary or replica shard on the server. This is the typical steady state of the ObjectGrid.

QUIESCE

public static final ObjectGridLifecycleListener.State QUIESCE

Work is stopping on the ObjectGrid as a result of the StateManager API or other event. No new work will be allowed. End any existing work as soon as possible.

OFFLINE

public static final ObjectGridLifecycleListener.State OFFLINE

All work is stopped on the ObjectGrid as a result of the StateManager API or other event. No new work will be allowed.

DESTROYING

public static final ObjectGridLifecycleListener.State DESTROYING

The ObjectGrid instance is starting the destroy phase. ObjectGrid plug-ins for the instance are about to be destroyed. During the destroy phase, all BackingMap instances owned by this ObjectGrid instance are also destroyed.

DESTROYED

public static final ObjectGridLifecycleListener.State DESTROYED

The ObjectGrid instance, its BackingMap instances and all ObjectGrid plug-ins have been destroyed.

Method Detail

values

public static ObjectGridLifecycleListener.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 (ObjectGridLifecycleListener.State c : ObjectGridLifecycleListener.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 ObjectGridLifecycleListener.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