com.ibm.websphere.objectgrid.stats
Interface OGStatsModule

All Superinterfaces:

StatsModule

public interface OGStatsModule
extends StatsModule

This interface represents a statistic module for an ObjectGrid. An ObjectGrid statistic module contains a Session transaction time statistic. The transaction time is the amount of time between when a transaction is started and committed.

The path to an ObjectGrid statistic module is the string "root", concatenated with "/", and then the ObjectGrid name. You can also use an array to represent the path, with the first element being the string "root", and the second element being the ObjectGrid name.

Since:

WAS XD 6.0.1

See Also:

ObjectGridMBean.retrieveStatsModule(), Session, Session.begin(), Session.commit()

Field Summary

Fields inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

MODULE_TYPE_AGENT, MODULE_TYPE_HASHINDEX, MODULE_TYPE_MAP, MODULE_TYPE_OBJECT_GRID, MODULE_TYPE_QUERY, MODULE_TYPE_SESSION, MODULE_TYPE_UNDEFINED, PATH_DELIMITER

Method Summary

ActiveTimeStatistic	getAllTypeTransactionTime() Retrieves the transaction response time statistic for all committed transactions.
ActiveTimeStatistic	getTransactionTime(String type, boolean copyMode) Retrieves the transaction response time statistic for committed transactions for a specific transaction type.

Methods inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

combine, copy, getPath, getStatsSpec, reset, setGroupModule, statsToString, update

Method Detail

getTransactionTime

ActiveTimeStatistic getTransactionTime(String type,
                                       boolean copyMode)

Retrieves the transaction response time statistic for committed transactions for a specific transaction type.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

type - the transaction type

copyMode - if set to true, a copy is returned.

Returns:

the transaction response time statistic for committed transactions for a specific transaction type

See Also:

ActiveTimeStatistic, Session.setTransactionType(String), Session.TRANSACTION_TYPE_DEFAULT

getAllTypeTransactionTime

ActiveTimeStatistic getAllTypeTransactionTime()

Retrieves the transaction response time statistic for all committed transactions.

Returns:

the combined transaction response time statistic for all committed transactions

See Also:

ActiveTimeStatistic