com.ibm.websphere.objectgrid.management
Interface ObjectGridMBean

public interface ObjectGridMBean

This MBean interface allows a client process to access different attributes and statistical data about a specific ObjectGrid on a server process. In a dynamic ObjectGrid environment, the object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=ObjectGrid,name=<objectgrid>,mapset=<mapset>,partition=<partition id>,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.0.1, XC10

Method Summary

String	getContainerName() Gets the name of the container name containing the replication group member for the ObjectGrid associated with this MBean.
long	getCurrentRevision() Retrieves the current revision number of this ObjectGrid shard.
String	getDomainName() Retrieves the domain name of this ObjectGrid shard.
TabularData	getKnownRevisions() An ObjectGrid shard may exist over several different lifetimes.
String	getLifetimeId() Retrieves the lifetime id for this ObjectGrid shard.
String	getObjectGridName() Gets the name of the ObjectGrid associated with this MBean.
long	getOGCount() Gets the ObjectGrid count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getOGMaxTranTime() Gets the maximum transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
double	getOGMeanTranTime() Gets the mean transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getOGMinTranTime() Gets the minimum transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
String	getOGStatsModule() Gets a string representation of the OGStatsModule attributes loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getOGTotalTranTime() Gets the total transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getOGTransPerSecond() Transactions per second attribute loaded up by the retrieveStatsModule call.
TabularData	getPrimaryShardLinks() Get the shard's list of foreign or domestic linked primaries.
String	getServerName() Gets the name of the server containing the replication group member for the ObjectGrid associated with this MBean.
OGStatsModule	retrieveStatsModule() Gets the OGStatsModule used to retrieve statistics associated with the ObjectGrid for this MBean.

Method Detail

retrieveStatsModule

OGStatsModule retrieveStatsModule()

Gets the OGStatsModule used to retrieve statistics associated with the ObjectGrid for this MBean.

Returns:

an OGStatsModule for statistics associated with this ObjectGrid

See Also:

OGStatsModule

getObjectGridName

String getObjectGridName()

Gets the name of the ObjectGrid associated with this MBean.

Returns:

name of the ObjectGrid

getServerName

String getServerName()

Gets the name of the server containing the replication group member for the ObjectGrid associated with this MBean.

Returns:

the name of server containing the replication group member for the ObjectGrid associated with this MBean.

getContainerName

String getContainerName()

Gets the name of the container name containing the replication group member for the ObjectGrid associated with this MBean.

Returns:

the name of container containing the replication group member for the ObjectGrid associated with this MBean.

Since:

8.5

getOGStatsModule

String getOGStatsModule()

Gets a string representation of the OGStatsModule attributes loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

String form of OGStatsModule

See Also:

retrieveStatsModule(), OGStatsModule

getOGCount

long getOGCount()

Gets the ObjectGrid count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

the number of transactions

See Also:

retrieveStatsModule(), OGStatsModule.getTransactionTime(String, boolean)

getOGMaxTranTime

long getOGMaxTranTime()

Gets the maximum transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

the maximum transaction time for the ObjectGrid in milliseconds

See Also:

retrieveStatsModule(), OGStatsModule.getTransactionTime(String, boolean)

getOGMinTranTime

long getOGMinTranTime()

Gets the minimum transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

the minimum transaction time for the ObjectGrid in milliseconds

See Also:

retrieveStatsModule(), OGStatsModule.getTransactionTime(String, boolean)

getOGMeanTranTime

double getOGMeanTranTime()

Gets the mean transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

the mean transaction time for the ObjectGrid in milliseconds

See Also:

retrieveStatsModule(), OGStatsModule.getTransactionTime(String, boolean)

getOGTotalTranTime

long getOGTotalTranTime()

Gets the total transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

the total transaction time for the ObjectGrid in milliseconds

See Also:

retrieveStatsModule(), OGStatsModule.getTransactionTime(String, boolean)

getOGTransPerSecond

long getOGTransPerSecond()

Transactions per second attribute loaded up by the retrieveStatsModule call. retrieveStatsModule() or refreshStatsModule() method.

Returns:

the transactions per second for the ObjectGrid

See Also:

retrieveStatsModule(), OGStatsModule.getTransactionTime(String, boolean)

getCurrentRevision

long getCurrentRevision()

Retrieves the current revision number of this ObjectGrid shard.

Returns:

the current revision number of this ObjectGrid shard.

Since:

7.1

getDomainName

String getDomainName()

Retrieves the domain name of this ObjectGrid shard.

Returns:

the name of the domain name of this ObjectGrid shard.

Since:

7.1

getLifetimeId

String getLifetimeId()

Retrieves the lifetime id for this ObjectGrid shard.

Returns:

the lifetime id for this ObjectGrid shard.

Since:

7.1

getKnownRevisions

TabularData getKnownRevisions()

An ObjectGrid shard may exist over several different lifetimes. As such, each shard instance will have a unique lifetime id and revision number associated with it. This method returns a TabularData object representing the known history of revision numbers for each lifetime. Each CompositeData (row in the TabularData) contains the following items:

Item Name	Type	Description	Since
Domain	String	The domain name of this ObjectGrid shard.	7.1
Server	String	The name of the server owning the lifetime id.	8.5
LifetimeId	String	The lifetime id of this ObjectGrid shard.	7.1
Revision	Long	The revision of this ObjectGrid shard.	7.1

Returns:

TabularData representing the known lifetimes and revisions of this shard.

Throws:

OpenDataException

Since:

7.1

See Also:

TabularData

getPrimaryShardLinks

TabularData getPrimaryShardLinks()

Get the shard's list of foreign or domestic linked primaries.

This method returns a TabularData object representing the current state of each primary shard link.

Each CompositeData (row in the TabularData) contains the following items:

Item Name	Type	Description
RemoteDomain	String	The catalog service domain name of the remote primary shard..
RemoteContainer	String	The container name of the remote primary shard.
Status	String	The status of the link. Valid states include: online and recovery.

Returns:

TabularData representing the linked primaries

Since:

7.1.1