IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.pmi.factory
Interface StatsInstance


public interface StatsInstance

StatsInstance represents a single instance of the Stats template. The instance will have all the statistics defined in the template. The Stats template XML file is defined using the stats.dtd at com/ibm/websphere/pmi/xml


Method Summary
 int getInstrumentationLevel()
          Return the current instrumentation/monitoring level for this StatsInstance.
 javax.management.ObjectName getMBean()
          Return the MBean name associated with this StatsInstance.
 com.ibm.websphere.pmi.stat.MBeanStatDescriptor getMBeanStatDescriptor()
          Deprecated. No replacement.
 java.lang.String getName()
          Returns the name of the instance
 SPIStatistic getStatistic(int id)
          Returns a statistic by ID.
 void setMBean(javax.management.ObjectName mBeanName)
          Associate a managed object MBean with this StatsInstance.
 

Method Detail

getName

java.lang.String getName()
Returns the name of the instance

Returns:
instance name

getMBean

javax.management.ObjectName getMBean()
Return the MBean name associated with this StatsInstance. Return null if no MBean is associated.

Returns:
MBean ObjectName

setMBean

void setMBean(javax.management.ObjectName mBeanName)
Associate a managed object MBean with this StatsInstance. This is required to access the statistics by calling getStats() on the managed object MBean.

Parameters:
mBeanName - managed object ObjectName

getInstrumentationLevel

int getInstrumentationLevel()
Return the current instrumentation/monitoring level for this StatsInstance. The instrumentation level is set via Administrative Console, WSAdmin, PerfMBean and PMI API. The default instrumentaion level is LEVEL_NONE when the instance is created. The various levels are defined in com.ibm.websphere.pmi.PmiConstants

Returns:
instrumentation level

getStatistic

SPIStatistic getStatistic(int id)
Returns a statistic by ID. The ID is defined in the Stats template.

Parameters:
id - Statistic ID
Returns:
Statistic

getMBeanStatDescriptor

com.ibm.websphere.pmi.stat.MBeanStatDescriptor getMBeanStatDescriptor()
Deprecated. No replacement.

Returns the MBeanStatDescriptor for this StatsInstance. If an MBean is associated with the StatsInstance then the ObjectName will be returned as part of the MBeanStatDescriptor.

Returns:
MBeanStatDescriptor of the StatsInstance

IBM WebSphere Application ServerTM
Release 8