com.ibm.websphere.objectgrid
Class AvailabilityState

java.lang.Object
  com.ibm.websphere.objectgrid.AvailabilityState

All Implemented Interfaces:

Serializable

public final class AvailabilityState
extends Object
implements Serializable

Each shard in a distributed ObjectGrid has an availability state associated with it. This state refers to the shard's ability to process incoming requests.

Since:

WAS XD 6.1.0.3, XC10

See Also:

Serialized Form

Field Summary

static AvailabilityState	OFFLINE An AvailabilityState.OFFLINE indicates that a shard is offline and unable to process requests.
static AvailabilityState	ONLINE An AvailabilityState.ONLINE indicates that a shard is online.
static AvailabilityState	PRELOAD An AvailabilityState.PRELOAD indicates that a shard is in the preload state.
static AvailabilityState	QUIESCE An AvailabilityState.QUIESCE indicates that a shard is in quiesce.
static AvailabilityState	UNKNOWN An AvailabilityState.UNKNOWN indicates that the availability state of the shard could not be determined.

Method Summary

int	getId() Returns the internal identifier for this state.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OFFLINE

public static final AvailabilityState OFFLINE

An AvailabilityState.OFFLINE indicates that a shard is offline and unable to process requests.

PRELOAD

public static final AvailabilityState PRELOAD

An AvailabilityState.PRELOAD indicates that a shard is in the preload state. When in the preload state, a shard will reject all requests that are not initiated from a client that is preloading data into the ObjectGrid.

ONLINE

public static final AvailabilityState ONLINE

An AvailabilityState.ONLINE indicates that a shard is online. A shard that is online is available for processing requests.

QUIESCE

public static final AvailabilityState QUIESCE

An AvailabilityState.QUIESCE indicates that a shard is in quiesce. Quiesce is a transitional state. Shards that are in the quiesce state are on their way to being offline. A shard in the quiesce state will allow all pending transactions to complete before moving to the AvailabilityState.OFFLINE, assuming that all pending transactions complete within 30 seconds after entering the quiesce state.

UNKNOWN

public static final AvailabilityState UNKNOWN

An AvailabilityState.UNKNOWN indicates that the availability state of the shard could not be determined.

Method Detail

getId

public int getId()

Returns the internal identifier for this state.

Returns:

the internal id.

Since:

7.1.1

toString

public String toString()

Overrides:

toString in class Object