|
Oracle Application Server DMS API Reference 10g Release 2 (10.1.2) B14002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dms.instrument.Sensor
Sensor
is an abstract class that represents the various types of Sensors that can be used for measuring performance. The Sensor
class defines common functionality including metric derivation, access to Sensor attributes, access to metric values, and destruction of Sensors. Each Sensor is contained by exactly one Noun.
By convention, Sensor names start with a lower case letter to distinguish them from Nouns. Character '/' is the default delimiter between Noun and Sensor names. It is not recommanded that '/' is used as a part of the Sensor name.
Field Summary | |
static int |
active Constant for the active metric |
static int |
all Constant for all the applicable metrics. |
static int |
average Constant for the average metric |
static int |
completed Constant for the completed metric |
static int |
count Constant for the count metric |
static int |
exclTime Constant for the exclTime metric |
static int |
maxActive Constant for the maxActive metric |
static int |
maximum Constant for the maximum metric |
static int |
minimum Constant for the minimum metric |
static int |
sum Constant for the sum metric |
static int |
time Constant for the time metric |
static int |
value Constant for the value metric |
Constructor Summary | |
protected |
Sensor() |
Method Summary | |
void |
deriveMetric(int metric) Instructs the Sensor to derive additional metrics. |
void |
destroy() Removes the Sensor from DMS and releases references to underlying resources. |
static Sensor |
get(java.lang.String pathname) Returns the Sensor corresponding to the supplied pathname, or null if no such node exists. |
java.lang.String |
getDescription() Returns a String containing a description of the Sensor. |
java.lang.String |
getName() Returns the name of the Sensor |
java.lang.Object |
getValue(int derivation) Returns the value for one of the Sensor's metrics |
void |
reset() Resets the Sensor's derived metrics back to initial values |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int value
public static final int time
public static final int count
public static final int completed
public static final int minimum
public static final int maximum
public static final int sum
public static final int average
public static final int active
public static final int maxActive
public static final int exclTime
public static int all
Constructor Detail |
protected Sensor()
Method Detail |
public void destroy()
public java.lang.String getDescription()
public java.lang.String getName()
public java.lang.Object getValue(int derivation)
derivation
- Bit value of the desired metric derivation. (e.g. Sensor.minimum
, Sensor.maximum
, ...)null
if the derivation does not exist for the Sensor.public void deriveMetric(int metric)
metric
- the metrics to be derived
Possible values include Sensor.minimum
, Sensor.maximum
, ... The values can be bitwise-ORed together, or multiple calls to deriveMetric can be made at the programmer's convenience.
The list of allowed derivations is Sensor-type specific.
public void reset()
public static Sensor get(java.lang.String pathname)
null
if no such node exists.pathname
- the pathname, in the form <delim>name<delim>name... examples: /Wisconsin/Green/Monroe.Oregon.Multnomah.Portland etc.null
.
|
Oracle Application Server DMS API Reference 10g Release 2 (10.1.2) B14002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |