com.ibm.websphere.objectgrid.management
Interface MapMBean

public interface MapMBean

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

 com.ibm.websphere.objectgrid:type=ObjectMap,name=<map>,partition=<partition id>,objectgrid=<objectgrid>,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 containing the replication group member for the map associated with this MBean.
double	getMapBatchUpdateMaxTime() Gets the maximum batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
double	getMapBatchUpdateMeanTime() Gets the mean batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
double	getMapBatchUpdateMinTime() Gets the minimum batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
double	getMapBatchUpdateTotalTime() Gets the total batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getMapCountStatistic() Gets the map count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getMapGetCountStatistic() Gets the get count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getMapHitCountStatistic() Gets the hit count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
double	getMapHitRateStatistic() Gets the hit rate attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
String	getMapName() Gets the name of the map associated with this MBean.
String	getMapStatsModule() Gets a string representation of the MapStatsModule attributes loaded up by the retrieveStatsModule() or refreshStatsModule() method.
long	getMapUsedBytes() Gets the used bytes attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
String	getObjectGridName() Gets the name of the ObjectGrid containing the map associated with this MBean.
int	getPartitionId() Retrieves the partition identifier for this map instance.
String	getServerName() Gets the name of the server containing the replication group member for the map associated with this MBean.
TabularData	retrieveEntries(String regex) Operation to iterate through all of the entries in this map, convert the key to string form, then match the string against the regular expression if passed, finally return the matching entries.
MapStatsModule	retrieveStatsModule() Gets the MapStatsModule used to retrieve statistics associated with the map for this MBean.

Method Detail

retrieveStatsModule

MapStatsModule retrieveStatsModule()

Gets the MapStatsModule used to retrieve statistics associated with the map for this MBean.

Returns:

A MapStatsModule for statistics associated with this map.

See Also:

MapStatsModule

getMapName

String getMapName()

Gets the name of the map associated with this MBean.

Returns:

The name of the map.

getObjectGridName

String getObjectGridName()

Gets the name of the ObjectGrid containing the map associated with this MBean.

Returns:

The name of the ObjectGrid for the map associated with this MBean.

getServerName

String getServerName()

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

Returns:

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

getMapStatsModule

String getMapStatsModule()

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

Returns:

The String form of MapStatsModule

See Also:

retrieveStatsModule(), MapStatsModule

getMapCountStatistic

long getMapCountStatistic()

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

Returns:

The number of entries in the map.

See Also:

retrieveStatsModule(), MapStatsModule.getNumEntries(boolean)

getMapHitRateStatistic

double getMapHitRateStatistic()

Gets the hit rate attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

Returns:

The hit rate for the map.

See Also:

retrieveStatsModule(), MapStatsModule.getHitRate(boolean)

getMapGetCountStatistic

long getMapGetCountStatistic()

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

Returns:

The get count for the map.

Since:

7.1

See Also:

retrieveStatsModule(), MapStatsModule.getHitRate(boolean)

getMapUsedBytes

long getMapUsedBytes()

Gets the used bytes attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.

The used bytes statistics are accurate only when you are using simple objects or the COPY_TO_BYTES copy mode.

Returns:

The number of bytes in use by the map.

Since:

7.1

See Also:

retrieveStatsModule(), MapStatsModule.getUsedBytes(boolean)

getMapHitCountStatistic

long getMapHitCountStatistic()

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

Returns:

The hit count for the map.

Since:

7.1

See Also:

retrieveStatsModule(), MapStatsModule.getHitRate(boolean)

getMapBatchUpdateMeanTime

double getMapBatchUpdateMeanTime()

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

Returns:

The mean batch update time for the map in milliseconds.

See Also:

retrieveStatsModule(), MapStatsModule.getBatchUpdateTime(boolean)

getMapBatchUpdateMaxTime

double getMapBatchUpdateMaxTime()

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

Returns:

The maximum batch update time for the map in milliseconds.

See Also:

retrieveStatsModule(), MapStatsModule.getBatchUpdateTime(boolean)

getMapBatchUpdateMinTime

double getMapBatchUpdateMinTime()

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

Returns:

The minimum batch update time for the map in milliseconds.

See Also:

retrieveStatsModule(), MapStatsModule.getBatchUpdateTime(boolean)

getMapBatchUpdateTotalTime

double getMapBatchUpdateTotalTime()

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

Returns:

The total batch update time for the map in milliseconds.

See Also:

retrieveStatsModule(), MapStatsModule.getBatchUpdateTime(boolean)

getPartitionId

int getPartitionId()

Retrieves the partition identifier for this map instance.

Returns:

The partition identifier.

Since:

WAS XD 6.1.0.4

getContainerName

String getContainerName()

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

Returns:

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

Since:

8.5

retrieveEntries

TabularData retrieveEntries(String regex)

Operation to iterate through all of the entries in this map, convert the key to string form, then match the string against the regular expression if passed, finally return the matching entries. This method could potentially return a very large data structure so care should be taken to ensure the regular expression will reduce the number of keys appropriately.

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

Item Name	Type	Description
KeyName	String	The domain name of this ObjectGrid shard.
LifetimeIndex	Short	The lifetime index for revisioning.
Revision	Long	The revision number of the last update.

Parameters:

regex - the regular expression to apply to the String form of the key. It should be used in narrowing the entries returned. If null, all entries are returned.

Returns:

A table of entries containing the user readable (String) form of the key and some meta information about the entry.

Since:

7.1.1