com.ibm.websphere.pmi

Class PmiModuleConfig

  1. java.lang.Object
  2. extended bycom.ibm.websphere.pmi.PmiModuleConfig
All implemented interfaces:
PmiConstants, java.io.Serializable

  1. public class PmiModuleConfig
  2. extends java.lang.Object
  3. implements java.io.Serializable, PmiConstants
This class contains configuration information for a Stats object (PMI module).
See Also:
Serialized Form

Field Summary

Fields inherited from interface com.ibm.websphere.pmi.PmiConstants
AE_35, AE_40, AES_40, ALL_DATA, APPSERVER_MODULE, BEAN_METHODS_SUBMODULE, BEAN_MODULE, CACHE_MODULE, COLLECTION_DESC, CONNPOOL_MODULE, DEFAULT_MODULE_PREFIX, EJB_ENTITY, EJB_MESSAGEDRIVEN, EJB_SINGLETON, EJB_STATEFUL, EJB_STATELESS, INITIALIZATION_FAILED, INITIALIZING, INTERCEPTOR_SUBMODULE, J2C_CF, J2C_DS, J2C_JMS_CONNECTIONS, J2C_MODULE, JAVA_TIME_CONVERT_RATIO, JVMPI_MODULE, LEVEL_DISABLE, LEVEL_ENABLE, LEVEL_FINEGRAIN, LEVEL_HIGH, LEVEL_HIGH_STRING, LEVEL_LOW, LEVEL_LOW_STRING, LEVEL_MAX, LEVEL_MAX_STRING, LEVEL_MEDIUM, LEVEL_MEDIUM_STRING, LEVEL_NONE, LEVEL_NONE_STRING, LEVEL_UNDEFINED, LOAD_AVG, LOST_CONTACT, METHODS_SUBMODULE_SHORTNAME, MSG_BUNDLE, NOT_IN_SUBMODULE, ORBPERF_MODULE, PLATFORM_ALL, PLATFORM_DISTRIBUTED, PLATFORM_ZOS, PMI_DISABLE_STRING, ROOT_DESC, ROOT_NAME, RUNNING, RUNTIME_MODULE, SERVLET_SUBMODULE, SERVLETS_SUBMODULE_SHORTNAME, SESSIONS_MODULE, STOPPED, SYSTEM_MODULE, TEMPLATE_SUBMODULE, TERMINATING, THREADPOOL_MODULE, TRAN_MODULE, TYPE_AVGSTAT, TYPE_CATEGORY, TYPE_COLLECTION, TYPE_DATA, TYPE_DOUBLE, TYPE_INSTANCE, TYPE_INT, TYPE_INVALID, TYPE_LOAD, TYPE_LONG, TYPE_MODULE, TYPE_MODULEROOT, TYPE_NODE, TYPE_RANGE, TYPE_ROOT, TYPE_SERVER, TYPE_STAT, TYPE_SUBINSTANCE, TYPE_SUBMODULE, TYPE_UNDEFINED, UNINITIALIZED, UNKNOWN_ID, WEBAPP_MODULE, WEBSERVICES_MODULE, WEBSERVICES_SUBMODULE, WLM_CLIENT_MODULE, WLM_MODULE, WLM_SERVER_MODULE, WSGW_MODULE, XML_COLLECTION, XML_COUNT, XML_CREATETIME, XML_DOUBLE, XML_ENDCOLLECTION, XML_ENDLINE, XML_ENDMODULE, XML_ENDNODE, XML_ENDSERVER, XML_ENDTAG, XML_ID, XML_INT, XML_INTEGRAL, XML_LASTVALUE, XML_LOAD, XML_LONG, XML_MODULE, XML_NAME, XML_NODE, XML_QUOTE, XML_SERVER, XML_START, XML_STAT, XML_SUMOFSQUARES, XML_TIME, XML_TOTAL, XML_VALUE, XML_VIEW

Constructor Summary

Constructor and Description
PmiModuleConfig(java.lang.String UID)
PMI data are organized in modules (Stats).

Method Summary

Modifier and Type Method and Description
  1. void
addData(PmiDataInfo info)
Add PmiDataInfo for a statistic (WebSphere internal use only)
  1. PmiModuleConfig
copy()
Creates a copy of this object
  1. int
getDataId(java.lang.String name)
Returns the data ID for a Statistic name in this module (Stats)
  1. PmiDataInfo
getDataInfo(int dataId)
Returns the PmiDataInfo for a data ID in this module (Stats)
  1. java.lang.String
getDescription()
Returns the description
  1. java.lang.String
getMbeanType()
Returns the mapping MBean type.
  1. int
getNumData()
Returns the number of statistics in this module
  1. java.lang.String
getResourceBundle()
Returns the resource bundle name.
  1. java.lang.String
getShortName()
Returns the Stats name - eg, beanModule (WebSphere internal use only)
  1. java.lang.String
getUID()
Returns the UID of this module (Stats).
  1. boolean
hasSubModule()
Returns true if there is a sub-module defined (applicable only to 5.x)
  1. PmiDataInfo[]
listAllData()
Returns the PmiDataInfo for all the statistics in the module.
  1. PmiDataInfo[]
listData(java.lang.String submoduleName)
Returns the submodule members.
  1. PmiDataInfo[]
listLevelData(int level)
Returns the statistic with level equal to or lower than 'level'
  1. PmiDataInfo[]
listMyLevelData(int level)
Returns the statistic with level equal to 'level'
  1. int[]
listStatisticsBySet(java.lang.String statisticSet)
Return the list of statistic IDs that are in the given pre-defined statistic sets.
  1. int[]
listStatisticsWithDependents()
Returns String representation of this object
  1. void
print(java.io.PrintWriter pw)
Deprecated. No replacement
  1. void
removeData(PmiDataInfo info)
Remove PmiDataInfo for a statistic (WebSphere internal use only)
  1. void
setDescription(java.lang.String description)
Sets the module description (WebSphere internal use only).
  1. void
setMbeanType(java.lang.String mbeanType)
Sets the mapping MBean type (WebSphere internal use only).
  1. void
setResourceBundle(java.lang.String nlsFile)
Sets the resource bundle to translate the Stats name, decription, and unit (WebSphere internal use only).
  1. PmiDataInfo[]
submoduleMembers(java.lang.String submoduleName)
Returns all the PmiDataInfo in the submodule.
  1. PmiDataInfo[]
submoduleMembers(java.lang.String submoduleName,int level)
Returns an array of PmiDataInfo for the given submoduleName and level.
  1. java.lang.String
toString()
Returns String representation of this object
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PmiModuleConfig

  1. public PmiModuleConfig(java.lang.String UID)
PMI data are organized in modules (Stats). Each module has a unique UID. This class contains all the PmiDataInfo (Statistics) for the module.

Method Detail

setDescription

  1. public void setDescription(java.lang.String description)
Sets the module description (WebSphere internal use only).

setMbeanType

  1. public void setMbeanType(java.lang.String mbeanType)
Sets the mapping MBean type (WebSphere internal use only).

setResourceBundle

  1. public void setResourceBundle(java.lang.String nlsFile)
Sets the resource bundle to translate the Stats name, decription, and unit (WebSphere internal use only).

addData

  1. public void addData(PmiDataInfo info)
Add PmiDataInfo for a statistic (WebSphere internal use only)

removeData

  1. public void removeData(PmiDataInfo info)
Remove PmiDataInfo for a statistic (WebSphere internal use only)

getResourceBundle

  1. public java.lang.String getResourceBundle( )
Returns the resource bundle name.

getNumData

  1. public int getNumData()
Returns the number of statistics in this module

getUID

  1. public java.lang.String getUID( )
Returns the UID of this module (Stats).

getShortName

  1. public java.lang.String getShortName( )
Returns the Stats name - eg, beanModule (WebSphere internal use only)

getDescription

  1. public java.lang.String getDescription( )
Returns the description

getMbeanType

  1. public java.lang.String getMbeanType( )
Returns the mapping MBean type.

getDataId

  1. public int getDataId(java.lang.String name)
Returns the data ID for a Statistic name in this module (Stats)

getDataInfo

  1. public PmiDataInfo getDataInfo( int dataId)
Returns the PmiDataInfo for a data ID in this module (Stats)

submoduleMembers

  1. public PmiDataInfo[] submoduleMembers( java.lang.String submoduleName)
Returns all the PmiDataInfo in the submodule. If submoduleName is null, return all the PmiDataInfo in the module.

submoduleMembers

  1. public PmiDataInfo[] submoduleMembers( java.lang.String submoduleName,
  2. int level)
Returns an array of PmiDataInfo for the given submoduleName and level.

listData

  1. public PmiDataInfo[] listData(java.lang.String submoduleName)
Returns the submodule members.

listAllData

  1. public PmiDataInfo[] listAllData( )
Returns the PmiDataInfo for all the statistics in the module.

listLevelData

  1. public PmiDataInfo[] listLevelData( int level)
Returns the statistic with level equal to or lower than 'level'

listMyLevelData

  1. public PmiDataInfo[] listMyLevelData( int level)
Returns the statistic with level equal to 'level'

  1. public void print(java.io.PrintWriter pw)
Deprecated. No replacement

toString

  1. public java.lang.String toString( )
Returns String representation of this object
Overrides:
toString in class java.lang.Object

listStatisticsWithDependents

  1. public int[] listStatisticsWithDependents( )
Returns String representation of this object

listStatisticsBySet

  1. public int[] listStatisticsBySet( java.lang.String statisticSet)
Return the list of statistic IDs that are in the given pre-defined statistic sets. Statistic sets are defined in StatConstants

hasSubModule

  1. public boolean hasSubModule()
Returns true if there is a sub-module defined (applicable only to 5.x)

copy

  1. public PmiModuleConfig copy()
Creates a copy of this object
Returns:
copy of this object