IBM WebSphere® DataPower® XC10 Appliance
Release 1.0 Client API Specification

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
 long getCurrentRevision()
          Retrieves the current revision number of this ObjectGrid shard.
 java.lang.String getDomainName()
          Retrieves the domain name of this ObjectGrid shard.
 javax.management.openmbean.TabularData getKnownRevisions()
          An ObjectGrid shard may exist over several different lifetimes.
 java.lang.String getLifetimeId()
          Retrieves the lifetime id for this ObjectGrid shard.
 java.lang.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.
 java.lang.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.
 java.lang.String getServerName()
          Gets the name of the server containing the replication group member for the ObjectGrid associated with this MBean.
 com.ibm.websphere.objectgrid.stats.OGStatsModule retrieveStatsModule()
          Gets the OGStatsModule used to retrieve statistics associated with the ObjectGrid for this MBean.
 

Method Detail

retrieveStatsModule

com.ibm.websphere.objectgrid.stats.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:
ObjectGridAdministrator.retrieveStatsModule(String[], int, String), OGStatsModule

getObjectGridName

java.lang.String getObjectGridName()
Gets the name of the ObjectGrid associated with this MBean.

Returns:
name of the ObjectGrid

getServerName

java.lang.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.

getOGStatsModule

java.lang.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:
StaticObjectGridMBean#refreshStatsModule(), 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:
StaticObjectGridMBean#refreshStatsModule(), 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:
StaticObjectGridMBean#refreshStatsModule(), 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:
StaticObjectGridMBean#refreshStatsModule(), 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:
StaticObjectGridMBean#refreshStatsModule(), 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:
StaticObjectGridMBean#refreshStatsModule(), 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:
StaticObjectGridMBean#refreshStatsModule(), 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

java.lang.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

java.lang.String getLifetimeId()
Retrieves the lifetime id for this ObjectGrid shard.

Returns:
the lifetime id for this ObjectGrid shard.
Since:
7.1

getKnownRevisions

javax.management.openmbean.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 NameTypeDescription
Domain String The domain name of this ObjectGrid shard.
LifetimeId String The lifetime id of this ObjectGrid shard.
Revision Long The revision of this ObjectGrid shard.

Returns:
TabularData representing the known lifetimes and revisions of this shard.
Throws:
javax.management.openmbean.OpenDataException
Since:
7.1
See Also:
TabularData

IBM WebSphere® DataPower® XC10 Appliance
Release 1.0 Client API Specification

© Copyright International Business Machines Corp 2005,2010. All rights reserved.