FileDocCategorySizeDatePackage
MonitoringStats.javaAPI DocGlassfish v2 API5257Fri May 04 22:30:54 BST 2007com.sun.appserv.management.monitor

MonitoringStats

public interface MonitoringStats implements Monitoring
Monitoring MBeans which expose one or more {@link Statistic} implement this interface.

Each MonitoringStats MBean exposes Statistics as Attributes formed using the following pattern:

 statistic-name_field-name 
For example, a CountStatistic names "Hosts" would generate the following Attributes:
  • Hosts_Name
  • Hosts_Description
  • Hosts_Unit
  • Hosts_StartTime
  • Hosts_LastSampleTime
  • Hosts_Count
For most purposes, it is the "name_Count" value which should be of primary interest.

The type of the Statistic will govern how many Attributes are generated, based on its actual fields, but every Statistic interface will have at least the Name, Description, Unit, StartTime and LastSampleTime fields present.

Note: These derived Attributes are not made available directly in the interface for the MBean; please refer to the documentation for each MonitoringStats MBean to determine which Statistics are available, and thus which derived Attributes available.

see
com.sun.appserv.management.base.AMX
see
com.sun.appserv.management.base.StdAttributesAccess
see
com.sun.appserv.management.base.Util#getExtra
see
com.sun.appserv.management.base.Extra
see
javax.management.j2ee.statistics.Statistic

Fields Summary
Constructors Summary
Methods Summary
public javax.management.openmbean.CompositeDataSupportgetOpenStatistic(java.lang.String name)
Get a JSR 77 Statistic encoded as a standard serializable JMX OpenType.

param
name the Statistic name

public javax.management.openmbean.CompositeDataSupport[]getOpenStatistics(java.lang.String[] names)
Get JSR 77 Statistics encoded as a standard serializable JMX OpenTypes. If a Statistic is not found, then null is returned in its array slot.

param
names the Statistic names
return
corresponding values for the names

public javax.management.openmbean.CompositeDataSupportgetOpenStats()
Get a JSR 77 Stats object encoded as a standard serializable JMX OpenType.

public javax.management.j2ee.statistics.StatisticgetStatistic(java.lang.String name)
Get a specific JSR 77 Statistic.

param
name the Statistic name

public java.lang.String[]getStatisticNames()
Get the names of all available Statistics.

public javax.management.j2ee.statistics.Statistic[]getStatistics(java.lang.String[] names)
Get specific JSR 77 Statistics. If a Statistic is not found, then null is returned in its array slot.

param
names the Statistic names
return
corresponding values for the names

public javax.management.j2ee.statistics.StatsgetStats()
Get a JSR 77 Stats object for all available statistics. Semantically, the returned Stats object MUST be a "snapshot" to the current state of the world.

public java.lang.StringgetStatsInterfaceName()

public booleanrefresh()
Refresh any stale data. This may or may not be applicable, depending on how the implementation performs its data collection. If the data is always "live", then the implementation of this routine does nothing.

return
true if there may be new data present, false otherwise