IBM WebSphere Application ServerTM
Release 8

com.ibm.ws.pmi.server
Class PerfLevelDescriptor

java.lang.Object
  extended by com.ibm.ws.pmi.server.PerfLevelDescriptor
All Implemented Interfaces:
com.ibm.websphere.pmi.client.PerfLevelSpec, com.ibm.websphere.pmi.PmiConstants, java.io.Serializable

public class PerfLevelDescriptor
extends java.lang.Object
implements com.ibm.websphere.pmi.client.PerfLevelSpec, com.ibm.websphere.pmi.PmiConstants

The class is the descriptor for setting/getting instrumentation level of PMI modules. Does not support 6.0 fine-grained control

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
PerfLevelDescriptor(java.lang.String[] path, int level)
          Constructor
PerfLevelDescriptor(java.lang.String[] path, int level, java.lang.String modID)
          Constructor
 
Method Summary
 int comparePath(com.ibm.websphere.pmi.client.PerfLevelSpec otherDesc)
          Returns 0 if exactly same
 int comparePath(java.lang.String[] otherPath)
          Returns 0 if exactly same
 int getLevel()
          Returns instrumentation level for the path
 java.lang.String getModuleName()
          Returns the module name in the path
 java.lang.String[] getPath()
          Returns the path of the PerfLevelDescriptor.
 java.lang.String[] getShortPath()
          Returns the path of the PerfLevelDescriptor without the preleading "pmi".
 java.lang.String getSubmoduleName()
          Returns the submodule name in the path
 java.lang.String getWCCMType()
           
 boolean isSubPath(com.ibm.websphere.pmi.client.PerfLevelSpec otherDesc)
          Returns true if it's path is a subpath of otherDesc
 boolean isSubPath(java.lang.String[] otherPath)
          Returns true if it's path is a subpath of otherPath
 void setLevel(int level)
          Sets instrumentation level for the path
 java.lang.String toString()
          Returns the string representaion of PerfLevelDescriptor for debug.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PerfLevelDescriptor

public PerfLevelDescriptor(java.lang.String[] path,
                           int level,
                           java.lang.String modID)
Constructor

Parameters:
path - Path of the Stats in the PMI tree.
level - instrumentation level for the path
modID - module ID

PerfLevelDescriptor

public PerfLevelDescriptor(java.lang.String[] path,
                           int level)
Constructor

Parameters:
path - Path of the Stats in the PMI tree.
level - instrumentation level for the path
Method Detail

getPath

public java.lang.String[] getPath()
Returns the path of the PerfLevelDescriptor. It has preleading root "pmi".

Specified by:
getPath in interface com.ibm.websphere.pmi.client.PerfLevelSpec

getShortPath

public java.lang.String[] getShortPath()
Returns the path of the PerfLevelDescriptor without the preleading "pmi".

Specified by:
getShortPath in interface com.ibm.websphere.pmi.client.PerfLevelSpec

comparePath

public int comparePath(com.ibm.websphere.pmi.client.PerfLevelSpec otherDesc)
Returns 0 if exactly same

Specified by:
comparePath in interface com.ibm.websphere.pmi.client.PerfLevelSpec

comparePath

public int comparePath(java.lang.String[] otherPath)
Returns 0 if exactly same

Specified by:
comparePath in interface com.ibm.websphere.pmi.client.PerfLevelSpec

isSubPath

public boolean isSubPath(com.ibm.websphere.pmi.client.PerfLevelSpec otherDesc)
Returns true if it's path is a subpath of otherDesc

Specified by:
isSubPath in interface com.ibm.websphere.pmi.client.PerfLevelSpec

isSubPath

public boolean isSubPath(java.lang.String[] otherPath)
Returns true if it's path is a subpath of otherPath

Specified by:
isSubPath in interface com.ibm.websphere.pmi.client.PerfLevelSpec

getModuleName

public java.lang.String getModuleName()
Returns the module name in the path

Specified by:
getModuleName in interface com.ibm.websphere.pmi.client.PerfLevelSpec

getSubmoduleName

public java.lang.String getSubmoduleName()
Returns the submodule name in the path

Specified by:
getSubmoduleName in interface com.ibm.websphere.pmi.client.PerfLevelSpec

getLevel

public int getLevel()
Returns instrumentation level for the path

Specified by:
getLevel in interface com.ibm.websphere.pmi.client.PerfLevelSpec

setLevel

public void setLevel(int level)
Sets instrumentation level for the path

Specified by:
setLevel in interface com.ibm.websphere.pmi.client.PerfLevelSpec

toString

public java.lang.String toString()
Returns the string representaion of PerfLevelDescriptor for debug.

Overrides:
toString in class java.lang.Object

getWCCMType

public java.lang.String getWCCMType()

IBM WebSphere Application ServerTM
Release 8