Skip navigation links

Oracle Application Server DMS API Reference
10g Release 3 (10.1.3.1.0)

B28943-01

A C D E G H I K L M N O P Q R S T U V


A

abort(long) - Method in class oracle.dms.instrument.PhaseEvent
Aborts the measurement of a phase.
active - Static variable in class oracle.dms.instrument.Sensor
Constant for the active metric
AdmlException - Exception in oracle.dms.aggregator
AdmlException indicates that errors appear in parsing XML document.
AdmlException(String) - Constructor for exception oracle.dms.aggregator.AdmlException
Creates a exception.
AdmlException(String, Exception) - Constructor for exception oracle.dms.aggregator.AdmlException
Creates a exception.
AdmlException(Exception) - Constructor for exception oracle.dms.aggregator.AdmlException
Creates a exception.
AggreMBeanIntf - Interface in oracle.dms.jmx
This interface contains the operations that are exposed as the operations of AggreMBean.
ALL - Static variable in class oracle.dms.instrument.DMSConsole
Constant for highest sensor weight.
ALL - Static variable in class oracle.dms.instrument.Noun
Tells the rollup feature to extract data from all descending Nouns.
all - Static variable in class oracle.dms.instrument.Sensor
Constant for all the applicable metrics.
and(RowSelector, RowSelector) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows that meet all criteria determined by both of the RowSelectors.
average - Static variable in class oracle.dms.instrument.Sensor
Constant for the average metric

C

close() - Method in interface oracle.dms.table.Table
Clears the contents of this Table.
columnCount() - Method in interface oracle.dms.table.Row
Gets the number of the columns in this Row.
columnCount() - Method in interface oracle.dms.table.Schema
Gets the number of the columns in this Table.
ColumnDefinition - Interface in oracle.dms.table
ColumnDefinition describes a column.
ColumnGroup - Interface in oracle.dms.table
ColumnGroup contains information about a group of columns.
columnGroupCount() - Method in interface oracle.dms.table.Schema
Gets the number of the ColumnGroups in this Table.
compare(Object, Object) - Method in class oracle.dms.table.RowComparator
Compares two Rows for order.
compareTo(Object) - Method in class oracle.dms.table.NameSupport
Compares to the given Name for order.
completed - Static variable in class oracle.dms.instrument.Sensor
Constant for the completed metric
containsColumn(String) - Method in interface oracle.dms.table.Row
Returns true if this Row contains the given column.
containsColumn(String) - Method in interface oracle.dms.table.Schema
Returns true if this Table contains the given column.
containsColumnGroup(String) - Method in interface oracle.dms.table.Schema
Returns true if this Table contains the given column group.
containsKey(String) - Method in class oracle.dms.table.Key
Returns true if this Table contains the given key column.
containsMember(String) - Method in interface oracle.dms.table.ColumnGroup
Returns true if this ColumnGroup contains the given member.
count - Static variable in class oracle.dms.instrument.Sensor
Constant for the count metric
create(Noun, String, String) - Static method in class oracle.dms.instrument.Event
Creates a new Event
create(String, String) - Static method in class oracle.dms.instrument.Noun
Creates a new Noun given a pathname.
create(Noun, String, String) - Static method in class oracle.dms.instrument.Noun
Creates a new Noun given a Noun parent, and a basename for the new Noun (not a pathname)
create(Noun, String, String) - Static method in class oracle.dms.instrument.PhaseEvent
Creates a new PhaseEvent.
create(Noun, String, byte, String, String) - Static method in class oracle.dms.instrument.State
Creates an uninitialized State Sensor.
create(Noun, String, String, String, int) - Static method in class oracle.dms.instrument.State
Deprecated. As of Oracle AS 10.1.2, replaced by State.create(Noun, String, byte, String, String)
create(Noun, String, String, String, long) - Static method in class oracle.dms.instrument.State
Deprecated. As of Oracle AS 10.1.2, replaced by State.create(Noun, String, byte, String, String)
create(Noun, String, String, String, double) - Static method in class oracle.dms.instrument.State
Deprecated. As of Oracle AS 10.1.2, replaced by State.create(Noun, String, byte, String, String)
create(Noun, String, String, String, Object) - Static method in class oracle.dms.instrument.State
Deprecated. As of Oracle AS 10.1.2, replaced by State.create(Noun, String, byte, String, String)

D

deriveMetric(int) - Method in class oracle.dms.instrument.Event
Derives additional metrics.
deriveMetric(int) - Method in class oracle.dms.instrument.PhaseEvent
Instructs the PhaseEvent to derive additional metrics.
deriveMetric(int) - Method in class oracle.dms.instrument.Sensor
Instructs the Sensor to derive additional metrics.
deriveMetric(int) - Method in class oracle.dms.instrument.State
Derives additional metrics for the State.
destroy() - Method in class oracle.dms.instrument.Noun
Destroys the Noun and all of its descendants.
destroy() - Method in class oracle.dms.instrument.Sensor
Removes the Sensor from DMS and releases references to underlying resources.
DIRECT - Static variable in class oracle.dms.instrument.Noun
Tells the rollup feature to extract data from child Nouns only.
DMSConsole - Class in oracle.dms.instrument
The Oracle Dynamic Monitoring Service (DMS) consists of a small set of simple Sensor classes that help Java programmers to measure important events and status values in their applications.
DMSConsole() - Constructor for class oracle.dms.instrument.DMSConsole
Constructs a new console.
DOUBLE - Static variable in class oracle.dms.instrument.State
Data type for State is the Java primitive double
DOUBLE - Static variable in interface oracle.dms.table.ColumnDefinition
the type ID for double column value
dump(String, String, boolean) - Method in class oracle.dms.instrument.DMSConsole
Dumps metrics for all DMS metrics to file.
dump(PrintWriter, String) - Method in class oracle.dms.instrument.DMSConsole
Dumps metrics for all DMS metrics to PrintWriter.

E

enumerateColumnDefinitions(boolean) - Method in interface oracle.dms.table.Schema
Enumerates ColumnDefinitions in this Table.
enumerateColumnGroups(boolean) - Method in interface oracle.dms.table.Schema
Enumerates ColumnGroups in this Table.
enumerateKeys(boolean) - Method in class oracle.dms.table.Key
Enumerates the names of the key columns in this Table as Strings.
enumerateMemberNames(boolean) - Method in interface oracle.dms.table.ColumnGroup
Enumerates the names of the members in this ColumnGroup.
enumerateNames(boolean) - Method in interface oracle.dms.table.Row
Enumerates column names this Row contains as Strings.
enumerateRows() - Method in interface oracle.dms.table.Table
Enumerates the Rows in this Table.
enumerateRows(RowComparator) - Method in interface oracle.dms.table.Table
Enumerates the Rows in this Table in the order determined by the given RowComparator object.
enumerateRows(RowSelector) - Method in interface oracle.dms.table.Table
Enumerates the Rows in this Table that meet the criteria determined by the given RowSelector object.
eq(String, Object) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows that have the given value at the given column.
eqIgnoreCase(String, String) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows where the values at the given column are equal to the given String if ignoring the case.
ERROR_OBJECT - Static variable in class oracle.dms.spy.ErrorObject
A predefined ErrorObject instance.
ErrorObject - Class in oracle.dms.spy
Metric value that is returned when something goes wrong.
ErrorObject() - Constructor for class oracle.dms.spy.ErrorObject
 
ErrorObject(String) - Constructor for class oracle.dms.spy.ErrorObject
 
Event - Class in oracle.dms.instrument
An Event Sensor is used to measure information about instantaneous, point events (events with negligible duration).
exclTime - Static variable in class oracle.dms.instrument.Sensor
Constant for the exclTime metric

G

ge(String, Object) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows where the values at the given column are greater than and equal to the given value.
get(String) - Static method in class oracle.dms.instrument.Noun
Returns a Noun given the Noun's pathname
get(String) - Static method in class oracle.dms.instrument.Sensor
Returns the Sensor corresponding to the supplied pathname, or null if no such node exists.
getColumnDefinition(String) - Method in interface oracle.dms.table.Schema
Gets the ColumnDefinition of the given column.
getColumnDefinitions() - Method in interface oracle.dms.table.Schema
Gets the ColumnDefinitions of the columns in an array.
getColumnGroup(String) - Method in interface oracle.dms.table.Schema
Gets the given ColumnGroup.
getColumnGroupNames() - Method in interface oracle.dms.table.Schema
Returns the names of the ColumnGroups in this Table as an array.
getColumnGroups() - Method in interface oracle.dms.table.Schema
Gets the ColumnGroups in this Table as an array.
getColumnNames() - Method in interface oracle.dms.table.Schema
Returns the names of the columns in this Table as an array.
getDescription() - Method in class oracle.dms.instrument.Sensor
Returns a String containing a description of the Sensor.
getDescription() - Method in interface oracle.dms.table.ColumnDefinition
Gets the description of the column.
getDescription() - Method in interface oracle.dms.table.ColumnGroup
Gets the description of this ColumnGroup.
getDescription() - Method in interface oracle.dms.table.Schema
Gets the description of the Table.
getDisplayName() - Method in interface oracle.dms.table.ColumnDefinition
Gets the display name of the column.
getDisplayName() - Method in interface oracle.dms.table.Schema
Gets the display name of the Table.
getKey() - Method in interface oracle.dms.table.Row
Returns the Key object of this Row.
getKey(boolean) - Method in interface oracle.dms.table.Row
Returns the Key object of this Row.
getKeys() - Method in class oracle.dms.table.Key
Gets the names of the key columns in this Table as an array.
getKeyValue(String) - Method in class oracle.dms.table.Key
Gets the value of the given key column.
getMemberNames() - Method in interface oracle.dms.table.ColumnGroup
Returns an array of member names in this ColumnGroup.
getMemberType(String) - Method in interface oracle.dms.table.ColumnGroup
Gets the type of the given memeber.
getName() - Method in class oracle.dms.instrument.Sensor
Returns the name of the Sensor
getName() - Method in interface oracle.dms.table.Name
Gets the name.
getName() - Method in class oracle.dms.table.NameSupport
Gets the name.
getNames() - Method in interface oracle.dms.table.Row
Returns the names of the columns in this Row as an array.
getNLSID() - Method in interface oracle.dms.table.ColumnDefinition
Gets the NLS ID of the column.
getNLSID() - Method in interface oracle.dms.table.Schema
Gets the NLS ID of the Table.
getRoot() - Static method in class oracle.dms.instrument.Noun
Returns the root Noun for this JVM
getRow(Key) - Method in interface oracle.dms.table.Table
Returns the Row identified by the given Key.
getSchema() - Method in interface oracle.dms.table.Table
Gets the Schema of this Table.
getSensorWeight() - Static method in class oracle.dms.instrument.DMSConsole
Get the Sensor weight for this JVM.
getTableNames(NamedValue[]) - Method in interface oracle.dms.jmx.AggreMBeanIntf
Gets an array of table names.
getTables(String[], NamedValue[], NamedValue[]) - Method in interface oracle.dms.jmx.AggreMBeanIntf
Gets an array of Table in the same order as the given table names.
getType() - Method in class oracle.dms.instrument.Noun
Returns the type of a Noun as a String.
getType() - Method in interface oracle.dms.table.ColumnDefinition
Gets the type of the column value.
getType() - Method in interface oracle.dms.table.ColumnGroup
Gets the type of this ColumnGroup.
getType(String) - Method in interface oracle.dms.table.Row
Gets the type of the column value.
getTypeID() - Method in interface oracle.dms.table.ColumnDefinition
Gets the numerical type ID of the column value.
getTypeID(String) - Method in interface oracle.dms.table.Row
Gets the numerical type ID of the column value.
getUnit() - Method in interface oracle.dms.table.ColumnDefinition
Gets the unit of the column.
getValue(int) - Method in class oracle.dms.instrument.Sensor
Returns the value for one of the Sensor's metrics
getValue() - Method in interface oracle.dms.jmx.NamedValue
Gets the value.
getValue() - Method in class oracle.dms.jmx.NamedValueSupport
Gets the value.
getValue(String) - Method in interface oracle.dms.table.Row
Returns the value of the given column.
getValueType() - Method in class oracle.dms.instrument.State
Get the type of data maintained in this object.
gt(String, Object) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows where the values at the given column are greater than the given value.

H

hasRows() - Method in interface oracle.dms.table.Table
Returns true if this Table contains Rows.
hasSchema() - Method in interface oracle.dms.table.Table
Returns true if this Table contains Schema.
HEAVY - Static variable in class oracle.dms.instrument.DMSConsole
Constant for above average sensor weight.
HOST - Static variable in interface oracle.dms.table.Schema
Special column that contains the host where the noun resides.

I

increment(int) - Method in class oracle.dms.instrument.State
Adds to the value of the State.
increment(long) - Method in class oracle.dms.instrument.State
Adds to the value of the State.
increment(double) - Method in class oracle.dms.instrument.State
Adds to the value of the State.
INTEGER - Static variable in class oracle.dms.instrument.State
Data type for State is the Java primitive int
INTEGER - Static variable in interface oracle.dms.table.ColumnDefinition
the type ID for integer column value
isKey() - Method in interface oracle.dms.table.ColumnDefinition
Returns whether the column is a key.

K

Key - Class in oracle.dms.table
Table class uses Key instances to uniquely identify Rows.
Key(Map) - Constructor for class oracle.dms.table.Key
Creates an object.
keyCount() - Method in class oracle.dms.table.Key
Gets the number of the key columns in this Table.

L

le(String, Object) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows where the values at the given column are less than and equal to the given value.
LONG - Static variable in class oracle.dms.instrument.State
Data type for State is the Java primitive long
LONG - Static variable in interface oracle.dms.table.ColumnDefinition
the type ID for long column value
lt(String, Object) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows where the values at the given column are less than the given value.

M

maxActive - Static variable in class oracle.dms.instrument.Sensor
Constant for the maxActive metric
maximum - Static variable in class oracle.dms.instrument.Sensor
Constant for the maximum metric
memberCount() - Method in interface oracle.dms.table.ColumnGroup
Gets the number of the members in this ColumnGroup.
minimum - Static variable in class oracle.dms.instrument.Sensor
Constant for the minimum metric

N

Name - Interface in oracle.dms.table
Name is the base interface for things with a name.
NAME - Static variable in interface oracle.dms.table.Schema
Special column that contains the noun name.
NamedValue - Interface in oracle.dms.jmx
NamedValue contains a pair of the name and the value.
NamedValueSupport - Class in oracle.dms.jmx
NamedValueSupport contains a pair of the name and value.
NamedValueSupport(String, Serializable) - Constructor for class oracle.dms.jmx.NamedValueSupport
Costructor.
NameSupport - Class in oracle.dms.table
NameSupport contains the name.
NameSupport(String) - Constructor for class oracle.dms.table.NameSupport
Constructor.
NONE - Static variable in class oracle.dms.instrument.DMSConsole
Constant for the lowest sensor weight.
NORMAL - Static variable in class oracle.dms.instrument.DMSConsole
Constant for default sensor weight.
not(RowSelector) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows that do not meet the criteria determined by the given RowSelectors.
Noun - Class in oracle.dms.instrument
Noun objects are used to organize the DMS name hierarchy.

O

OBJECT - Static variable in class oracle.dms.instrument.State
Data type for State is java.lang.Object
occurred() - Method in class oracle.dms.instrument.Event
Signals to DMS that the Event occurred
or(RowSelector, RowSelector) - Static method in class oracle.dms.table.RowSelector
Returns a RowSelector selecting Rows that meet the criteria determined by either one of the RowSelectors.
oracle.dms.aggregator - package oracle.dms.aggregator
 
oracle.dms.instrument - package oracle.dms.instrument
 
oracle.dms.jmx - package oracle.dms.jmx
 
oracle.dms.spy - package oracle.dms.spy
 
oracle.dms.table - package oracle.dms.table
 

P

PARENT - Static variable in interface oracle.dms.table.Schema
Special column that contains the parent noun name.
PhaseEvent - Class in oracle.dms.instrument
A PhaseEvent is used to measure important intervals, phases, or blocks of code.
PROCESS - Static variable in interface oracle.dms.table.Schema
Special column that contains the process where the noun resides.

Q

queryTables(String, String[], NamedValue[], NamedValue[]) - Method in interface oracle.dms.jmx.AggreMBeanIntf
Gets an array of Table in the same order as the given table names according to the given ADML document.

R

reset() - Method in class oracle.dms.instrument.Sensor
Resets the Sensor's derived metrics back to initial values
rollup(String, byte) - Method in class oracle.dms.instrument.Noun
Rolls up Sensor metrics from descendent Nouns of the specified type.
Row - Interface in oracle.dms.table
Row contains the column names and values of the metric table.
RowComparator - Class in oracle.dms.table
A RowComparator compares Rows by the values of the given column.
RowComparator(String, boolean) - Constructor for class oracle.dms.table.RowComparator
Creates an RowComparator.
rowCount() - Method in interface oracle.dms.table.Table
Gets the number of the rows in this Table.
RowSelector - Class in oracle.dms.table
A RowSelector selects Rows according to the given criteria.

S

Schema - Interface in oracle.dms.table
Schema contains the schema of a Table.
select(Row) - Method in class oracle.dms.table.RowSelector
Selects Rows according to the criteria.
Sensor - Class in oracle.dms.instrument
Sensor is an abstract class that represents the various types of Sensors that can be used for measuring performance.
Sensor() - Constructor for class oracle.dms.instrument.Sensor
 
setCopy(boolean) - Method in class oracle.dms.instrument.State
Set the State to store a String copy of the maintained object.
setName(String) - Method in class oracle.dms.jmx.NamedValueSupport
Sets the name.
setValue(Serializable) - Method in class oracle.dms.jmx.NamedValueSupport
Sets the value.
start() - Method in class oracle.dms.instrument.PhaseEvent
Signals the beginning of the phase.
start(long) - Method in class oracle.dms.instrument.PhaseEvent
Signals the beginning of the phase.
State - Class in oracle.dms.instrument
A State Sensor can be used to monitor pre-computed metric values.
stop(long) - Method in class oracle.dms.instrument.PhaseEvent
Signals the end of the Phase.
stop(long, long) - Method in class oracle.dms.instrument.PhaseEvent
Signals the end of the phase.
stop2(long) - Method in class oracle.dms.instrument.PhaseEvent
Signals the end of the phase.
STRING - Static variable in interface oracle.dms.table.ColumnDefinition
the type ID for string column value
sum - Static variable in class oracle.dms.instrument.Sensor
Constant for the sum metric

T

Table - Interface in oracle.dms.table
Table contains metric values of a metric table.
tableCount(NamedValue[]) - Method in interface oracle.dms.jmx.AggreMBeanIntf
Returns number of Tables.
time - Static variable in class oracle.dms.instrument.Sensor
Constant for the time metric

U

UNKNOWN - Static variable in interface oracle.dms.table.ColumnDefinition
the type ID for default column value
UNKNOWN_TYPE - Static variable in class oracle.dms.instrument.Noun
The default Noun type.
update(int) - Method in class oracle.dms.instrument.State
Updates the value of the State.
update(long) - Method in class oracle.dms.instrument.State
Updates the value of the State.
update(double) - Method in class oracle.dms.instrument.State
Updates the value of the State.
update(Object) - Method in class oracle.dms.instrument.State
Updates the value of the State.

V

value - Static variable in class oracle.dms.instrument.Sensor
Constant for the value metric

A C D E G H I K L M N O P Q R S T U V

Oracle Application Server DMS API Reference
10g Release 3 (10.1.3.1.0)

B28943-01


Copyright © 2004, 2006, Oracle. All Rights Reserved.