IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.pmi
Class PmiModuleConfig

java.lang.Object
  extended by com.ibm.websphere.pmi.PmiModuleConfig
All Implemented Interfaces:
PmiConstants, java.io.Serializable

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

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

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


setMbeanType

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


setResourceBundle

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


addData

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


removeData

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


getResourceBundle

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


getNumData

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


getUID

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


getShortName

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


getDescription

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


getMbeanType

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


getDataId

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


getDataInfo

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


submoduleMembers

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

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


listData

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


listAllData

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


listLevelData

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


listMyLevelData

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


print

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


toString

public java.lang.String toString()
Returns String representation of this object

Overrides:
toString in class java.lang.Object

listStatisticsWithDependents

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


listStatisticsBySet

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

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


copy

public PmiModuleConfig copy()
Creates a copy of this object

Returns:
copy of this object

IBM WebSphere Application ServerTM
Release 8