com.ibm.websphere.objectgrid.management
Interface ShardMBean

public interface ShardMBean

This MBean interface allows a client process to perform operations on and get status from a shard running in a dynamic environment. The object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=Shard,name=<objectgrid>,objectgrid=<objectgrid>,mapset=<mapset>,partition=<partition id>,container=<container>,host=<host>,ogServerName=<server>
 

If ObjectGrid is running in a WebSphere Application Server process, more key=value pairs may be added to the object name.

Since:

WAS XD 6.1 FIX3, XC10

Field Summary

static String	ROLE_SWAP_REQUESTED_WITH_SAME_TYPE Indicates that this shard is the same type of shard as the requested swap type.
static String	ROLE_SWAP_SUCCESSFUL Indicates that the role swap was executed successfully.
static String	ROLE_SWAP_TIMEOUT Indicates that this shard has timed out waiting to inherit its requested role
static String	TYPE_INACTIVE Indicates the shard type is the inactive role.
static String	TYPE_PRIMARY Indicates the shard type is the primary role.
static String	TYPE_REPLICA_ASYNCHRONOUS Indicates the shard type is the asynchronous replica role.
static String	TYPE_REPLICA_SYNCHRONOUS Indicates the shard type is the synchronous replica role.

Method Summary

long	getActiveRequestCount() Retrieves the number of requests currently being processed by this shard.
String	getContainerName() Retrieves the name of the container that is hosting this shard.
String	getDomainName() Retrieve the name of the catalog server grouping administering this shard.
long	getForwardedRequestCount() Retrieves the number of requests that this shard has forwarded since its inception.
String	getMapSetName() Retrieve the name of the MapSet in which the shard resides.
String	getObjectGridName() Retrieve the name of the ObjectGrid in which the shard resides.
String	getPartitionName() Retreive the name of the partition in which the shard resides.
long	getProcessedRequestCount() Retrieves the number of requests that this shard has processed since its inception.
String	getState() Retrieve the state of the shard.
long	getTotalRequestCount() Retrieves the number of requests that this shard has processed or forwarded since its inception.
String	getType() Retrieve the type of the shard.
String	swapWithPrimary() Causes this shard to swap roles with the primary shard for the partition.

Field Detail

ROLE_SWAP_SUCCESSFUL

static final String ROLE_SWAP_SUCCESSFUL

Indicates that the role swap was executed successfully.

Since:

7.1.0.0 FIX1

See Also:

swapWithPrimary(), Constant Field Values

ROLE_SWAP_REQUESTED_WITH_SAME_TYPE

static final String ROLE_SWAP_REQUESTED_WITH_SAME_TYPE

Indicates that this shard is the same type of shard as the requested swap type. No swap will be executed.

Since:

7.1.0.0 FIX1

See Also:

swapWithPrimary(), Constant Field Values

ROLE_SWAP_TIMEOUT

static final String ROLE_SWAP_TIMEOUT

Indicates that this shard has timed out waiting to inherit its requested role

Since:

7.1.0.0 FIX1

See Also:

swapWithPrimary(), Constant Field Values

TYPE_PRIMARY

static final String TYPE_PRIMARY

Indicates the shard type is the primary role. This means that this is the shard that handles all updates and coordinates state transitions with the replicas.

See Also:

Constant Field Values

TYPE_REPLICA_SYNCHRONOUS

static final String TYPE_REPLICA_SYNCHRONOUS

Indicates the shard type is the synchronous replica role. This means that this shard is receiving state updates from another shard that is acting as primary.

See Also:

Constant Field Values

TYPE_REPLICA_ASYNCHRONOUS

static final String TYPE_REPLICA_ASYNCHRONOUS

Indicates the shard type is the asynchronous replica role. This means that this shard is receiving state updates from another shard that is acting as primary.

See Also:

Constant Field Values

TYPE_INACTIVE

static final String TYPE_INACTIVE

Indicates the shard type is the inactive role. This means that this shard is not actively enrolled in the partition.

See Also:

Constant Field Values

Method Detail

getObjectGridName

String getObjectGridName()

Retrieve the name of the ObjectGrid in which the shard resides.

Returns:

The ObjectGrid name.

getMapSetName

String getMapSetName()

Retrieve the name of the MapSet in which the shard resides.

Returns:

The MapSet name.

getPartitionName

String getPartitionName()

Retreive the name of the partition in which the shard resides.

Returns:

The partition name.

getType

String getType()

Retrieve the type of the shard.

Returns:

The shard type.

getDomainName

String getDomainName()

Retrieve the name of the catalog server grouping administering this shard.

Returns:

The domain name.

getState

String getState()

Retrieve the state of the shard.

Returns:

The shard state.

getTotalRequestCount

long getTotalRequestCount()

Retrieves the number of requests that this shard has processed or forwarded since its inception.

Returns:

A count of the total number of requests.

getActiveRequestCount

long getActiveRequestCount()

Retrieves the number of requests currently being processed by this shard.

Returns:

A count of the active requests.

getForwardedRequestCount

long getForwardedRequestCount()

Retrieves the number of requests that this shard has forwarded since its inception.

Returns:

A count of the total number of forwarded requests.

getProcessedRequestCount

long getProcessedRequestCount()

Retrieves the number of requests that this shard has processed since its inception.

Returns:

A count of the total number of processed requests.

getContainerName

String getContainerName()

Retrieves the name of the container that is hosting this shard.

Returns:

The name of the container.

Since:

WAS XD 6.1.0.3

swapWithPrimary

String swapWithPrimary()

Causes this shard to swap roles with the primary shard for the partition. This shard becomes the primary while the shard that was previously the primary inherits this shard's former role.

If the role swap is not complete within 10 seconds, this operation will timeout.

Returns:

String the contains the return code of the operation

Since:

7.1.0.0 FIX1

See Also:

ROLE_SWAP_SUCCESSFUL, ROLE_SWAP_REQUESTED_WITH_SAME_TYPE, ROLE_SWAP_TIMEOUT