com.ibm.websphere.objectgrid
Interface StateManager

public interface StateManager

The StateManager can be used to retrieve the availability state of an ObjectGrid. Use the StateManagerFactory.getStateManager() method to retrieve a StateManager instance.

Since:

WAS XD 6.1.0.3, XC10

Method Summary

AvailabilityState	getObjectGridState(ObjectGrid objectGrid) Get the AvailabilityState of an ObjectGrid.
void	setObjectGridState(AvailabilityState state, ObjectGrid objectGrid) Set the AvailabilityState for an ObjectGrid.

Method Detail

getObjectGridState

AvailabilityState getObjectGridState(ObjectGrid objectGrid)

Get the AvailabilityState of an ObjectGrid. A random shard within the ObjectGrid is chosen for reporting availability state.

Parameters:

objectGrid - the availability state of the specified remote ObjectGrid will be retrieved

Returns:

the AvailabilityState of the remote ObjectGrid

Throws:

IllegalArgumentException. - If parameter objectGrid, is either null or it is of type 'LOCAL'. See ObjectGrid.getObjectGridType().

TargetNotAvailableException - if there are no active shards for the ObjectGrid specified.

setObjectGridState

void setObjectGridState(AvailabilityState state,
                        ObjectGrid objectGrid)

Set the AvailabilityState for an ObjectGrid. Each shard in the ObjectGrid will be transitioned to the state specified. This method does not return until each shard in the ObjectGrid has transitioned to the AvailabilityState specified or if it times-out.

Parameters:

state - the AvailabilityState to transition to.

objectGrid - the ObjectGrid to transaction to the specified AvailabilityState.

Throws:

IllegalArgumentException. -

1. If parameter ObjectGrid. is either null or is of type 'LOCAL'. See ObjectGrid.getObjectGridType().
2. If parameter AvailabilityState is null.