com.ibm.websphere.pmi

Class PmiDataInfo

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

  1. public class PmiDataInfo
  2. extends java.lang.Object
  3. implements java.io.Serializable, PmiConstants
This class represents the specification of an individual Statistic in 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
PmiDataInfo(int id)
Constructor
PmiDataInfo(int id,java.lang.String name,int type,int level,java.lang.String description)
Constructor
PmiDataInfo(int id,java.lang.String name,java.lang.String unit,java.lang.String description,int type,int level,boolean resettable)
Constructor

Method Summary

Modifier and Type Method and Description
  1. void
addDependency(int id)
(WebSphere internal use only)
  1. PmiDataInfo
copy()
Creates a copy of this object
  1. java.lang.String
getCategory()
Return the applicable category of this statistic.
  1. java.lang.String
getComment()
Returns the comment string for this statistic
  1. java.util.ArrayList
getDependency()
Returns the list of statistics that this statistic depends on
  1. java.lang.String
getDescription()
Returns the description
  1. int
getId()
Returns the statistic ID
  1. int
getLevel()
Returns the statistic instrumentaion level (List of levels defined in PmiConstants)
  1. java.lang.String
getName()
Returns the name of the statsitic
  1. java.lang.String
getParticipation()
Deprecated. No replacement
  1. java.lang.String
getPlatform()
Returns the platform in which this statistic is supported (List of platforms defined in PmiConstants)
  1. java.lang.String
getStatisticSet()
Returns the statistic set that this statistic belongs to (Statistic sets defined in com.ibm.websphere.pmi.stat.StatConstants)
  1. java.lang.String
getSubmoduleName()
Returns the PMI sub-module name to which this statistic belongs to.
  1. int
getType()
Returns the statistic type (defined in PmiConstants)
  1. java.lang.String
getUnit()
Return the statistic unit
  1. boolean
isAggregatable()
Return true if this statistic can be aggregated by the parent
  1. boolean
isAvailableInPlatform(java.lang.String p)
Return true if this statistic is available in the given platform
  1. boolean
isResettable()
Return true if it can be reset to zero in client side.
  1. boolean
isUpdateOnRequest()
Return true if this statistic is updated only on request
  1. boolean
isZosAggregatable()
Return true if the value of statistic from zos servant regions is aggregatable
  1. void
setAggregatable(boolean aggregatable)
(WebSphere internal use only)
  1. void
setCategory(java.lang.String category)
(WebSphere internal use only)
  1. void
setComment(java.lang.String comment)
(WebSphere internal use only)
  1. void
setDescription(java.lang.String description)
(WebSphere internal use only)
  1. void
setLevel(int level)
(WebSphere internal use only)
  1. void
setName(java.lang.String name)
(WebSphere internal use only)
  1. void
setOnRequest(boolean onRequest)
(WebSphere internal use only)
  1. void
setParticipation(java.lang.String participation)
(WebSphere internal use only)
  1. void
setPlatform(java.lang.String platform)
(WebSphere internal use only)
  1. void
setResettable(boolean resettable)
(WebSphere internal use only)
  1. void
setStatisticSet(java.lang.String statSet)
(WebSphere internal use only)
  1. void
setSubmoduleName(java.lang.String submoduleName)
(WebSphere internal use only)
  1. void
setType(int type)
(WebSphere internal use only)
  1. void
setUnit(java.lang.String unit)
(WebSphere internal use only)
  1. void
setZosAggregatable(boolean zosAggregatable)
(WebSphere internal use only)
  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

PmiDataInfo

  1. public PmiDataInfo(int id)
Constructor
Parameters:
id - Uniquely identifies a statistic in a Stats object

PmiDataInfo

  1. public PmiDataInfo(int id,
  2. java.lang.String name,
  3. int type,
  4. int level,
  5. java.lang.String description)
Constructor
Parameters:
id - Uniquely identifies a statistic in a Stats objecy
name - Name of the statistic
type - Type of the statistic (defined in PmiConstants)
level - Instrumentation level (defined in PmiConstants)
description - Desription of the statistic

PmiDataInfo

  1. public PmiDataInfo(int id,
  2. java.lang.String name,
  3. java.lang.String unit,
  4. java.lang.String description,
  5. int type,
  6. int level,
  7. boolean resettable)
Constructor
Parameters:
id - Uniquely identifies a statistic in a Stats objecy
name - Name of the statistic
unit - Unit of the statistic
type - Type of the statistic (defined in PmiConstants)
level - Instrumentation level (defined in PmiConstants)
description - Desription of the statistic
resettable - Indicates if this statistic can be reset to zero in client side

Method Detail

setName

  1. public void setName(java.lang.String name)
(WebSphere internal use only)

setType

  1. public void setType(int type)
(WebSphere internal use only)

setParticipation

  1. public void setParticipation(java.lang.String participation)
(WebSphere internal use only)

setDescription

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

setUnit

  1. public void setUnit(java.lang.String unit)
(WebSphere internal use only)

setCategory

  1. public void setCategory(java.lang.String category)
(WebSphere internal use only)

setLevel

  1. public void setLevel(int level)
(WebSphere internal use only)

setStatisticSet

  1. public void setStatisticSet(java.lang.String statSet)
(WebSphere internal use only)

setPlatform

  1. public void setPlatform(java.lang.String platform)
(WebSphere internal use only)

setComment

  1. public void setComment(java.lang.String comment)
(WebSphere internal use only)

setResettable

  1. public void setResettable(boolean resettable)
(WebSphere internal use only)

setAggregatable

  1. public void setAggregatable(boolean aggregatable)
(WebSphere internal use only)

setZosAggregatable

  1. public void setZosAggregatable( boolean zosAggregatable)
(WebSphere internal use only)

setOnRequest

  1. public void setOnRequest(boolean onRequest)
(WebSphere internal use only)

setSubmoduleName

  1. public void setSubmoduleName(java.lang.String submoduleName)
(WebSphere internal use only)

addDependency

  1. public void addDependency(int id)
(WebSphere internal use only)

getDependency

  1. public java.util.ArrayList getDependency( )
Returns the list of statistics that this statistic depends on

getName

  1. public java.lang.String getName( )
Returns the name of the statsitic

getId

  1. public int getId()
Returns the statistic ID

getType

  1. public int getType()
Returns the statistic type (defined in PmiConstants)

getDescription

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

getUnit

  1. public java.lang.String getUnit( )
Return the statistic unit

getCategory

  1. public java.lang.String getCategory( )
Return the applicable category of this statistic. For example, an EJB counter could be only applicable to entity bean.

getParticipation

  1. public java.lang.String getParticipation( )
Deprecated. No replacement

getLevel

  1. public int getLevel()
Returns the statistic instrumentaion level (List of levels defined in PmiConstants)

getStatisticSet

  1. public java.lang.String getStatisticSet( )
Returns the statistic set that this statistic belongs to (Statistic sets defined in com.ibm.websphere.pmi.stat.StatConstants)

getPlatform

  1. public java.lang.String getPlatform( )
Returns the platform in which this statistic is supported (List of platforms defined in PmiConstants)

getComment

  1. public java.lang.String getComment( )
Returns the comment string for this statistic

isResettable

  1. public boolean isResettable()
Return true if it can be reset to zero in client side.

isAggregatable

  1. public boolean isAggregatable()
Return true if this statistic can be aggregated by the parent

isZosAggregatable

  1. public boolean isZosAggregatable( )
Return true if the value of statistic from zos servant regions is aggregatable

isAvailableInPlatform

  1. public boolean isAvailableInPlatform( java.lang.String p)
Return true if this statistic is available in the given platform
Parameters:
p - - platform string defined in PmiConstants

isUpdateOnRequest

  1. public boolean isUpdateOnRequest( )
Return true if this statistic is updated only on request

getSubmoduleName

  1. public java.lang.String getSubmoduleName( )
Returns the PMI sub-module name to which this statistic belongs to.

toString

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

copy

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