|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WLDFHarvesterRuntimeMBean
Provides aggregated information about all active Harvester configurations, as well as metadata about harvestable and harvested attributes, types, and instances. Harvestable means potentially available for harvesting; harvested means explicitly designated for harvesting. These terms apply to types, instances, and the attributes within those types. In addition, the interface provides access to sampling and snapshot statistics. All statistics are base on data collected during the current server session.
Method Summary | |
---|---|
Map<String,MBeanAttributeInfo[]> |
getAttributeInfoForAllTypes()
This method returns all Harvester types and their MBeanAttributeInfos. |
long |
getAverageSamplingTime()
The average amount of time, in nanoseconds, spent in sampling cycles. |
long |
getCurrentDataSampleCount()
Deprecated. |
String[] |
getCurrentlyHarvestedAttributes(String type)
Deprecated. |
String[] |
getCurrentlyHarvestedInstances(String type)
Deprecated. |
long |
getCurrentSnapshotElapsedTime()
Deprecated. |
long |
getCurrentSnapshotStartTime()
Deprecated. |
String[][] |
getHarvestableAttributes(String type)
Deprecated. |
String[][] |
getHarvestableAttributesForInstance(String instancePattern)
Deprecated. |
String |
getHarvestableType(String instanceName)
Deprecated. |
Map<String,ObjectName[]> |
getInstancesForAllTypes()
This method returns all Harvester types and their instances |
String[] |
getKnownHarvestableInstances(String type)
Deprecated. |
String[] |
getKnownHarvestableTypes()
The set of all known types, regardless of whether the types are currently configured for harvesting. |
long |
getMaximumSamplingTime()
The maximum sampling time, in nanoseconds. |
long |
getMinimumSamplingTime()
The minimum sampling time, in nanoseconds. |
float |
getOutlierDetectionFactor()
Deprecated. |
long |
getSamplePeriod()
Deprecated. |
long |
getTotalDataSampleCount()
Deprecated. |
long |
getTotalSamplingCycles()
The total number of sampling cycles taken thus far. |
long |
getTotalSamplingTime()
The total amount of time, in nanoseconds, spent in sampling cycles. |
long |
getTotalSamplingTimeOutlierCount()
Deprecated. |
boolean |
isCurrentSampleTimeAnOutlier()
Deprecated. |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Method Detail |
---|
String[][] getHarvestableAttributes(String type) throws HarvesterException.HarvestableTypesNotFoundException, HarvesterException.AmbiguousTypeName, HarvesterException.TypeNotHarvestable
The set of attributes that are eligible for harvesting for the specified type. The specified type does not need to be currently configured for harvesting. For MBeans other than WebLogic Server MBeans, returns null until at least one instance has been created.
The returned array represents a list of pairs. The first element in each pair is the attribute name and the second element is the class name of the attribute's type.
type
- the name of the type to get the attributes for
HarvesterException.HarvestableTypesNotFoundException
- if the type
name is valid but could not be located
HarvesterException.AmbiguousTypeName
- if the
type name requires qualification to resolve
HarvesterException.TypeNotHarvestableException
- if the
type could never be harvested
HarvesterException.TypeNotHarvestable
String[][] getHarvestableAttributesForInstance(String instancePattern) throws HarvesterException.HarvestableTypesNotFoundException, HarvesterException.AmbiguousTypeName, HarvesterException.TypeNotHarvestable
The set of attributes that are eligible for harvesting for the specified instance name. The type of the specified instance does not need to be currently configured for harvesting. For MBeans other than WebLogic Server MBeans, returns null until at least one instance has been created.
Note that in the case where an ObjectName pattern is specified for a WebLogic Server MBean, the ObjectName's property list must contain the "Type" property (e.g., "com.bea:Type=ServerRuntime,*"). Otherwise, as is the case for any non-WebLogic Server MBean, an instance must exist in order for the set of harvestable attributes to be known.
The returned array represents a list of pairs. The first element in each pair is the attribute name and the second element is the class name of the attribute's type.
instancePattern
- the ObjectName or ObjectName pattern of the type to get the
attributes for
HarvesterException.HarvestableTypesNotFoundException
- if the type name is valid but could not be located
HarvesterException.AmbiguousTypeName
- if the type name requires qualification to resolve
HarvesterException.TypeNotHarvestableException
- if the type could never be harvested
HarvesterException.TypeNotHarvestable
String[] getCurrentlyHarvestedAttributes(String type) throws HarvesterException.MissingConfigurationType, HarvesterException.HarvestingNotEnabled, HarvesterException.AmbiguousTypeName
The set of attributes that are currently being harvested for the specified type. The specified type must be explicitly configured for harvesting.
The returned set of attributes usually matches the corresponding set of attributes configured for harvesting; but if an error occurs when harvesting an attribute, that attribute will be omitted from the returned set.
type
- the name of the type to get the attributes for
HarvesterException.MissingConfigurationType
- if the provided type
is not configured for harvesting
HarvesterException.HarvestingNotEnabled
- if the Harvester is not deployed
HarvesterException.HarvesterException.AmbiguousTypeName
- if the
type name requires qualification to resolve
HarvesterException.AmbiguousTypeName
String[] getKnownHarvestableTypes()
The set of all known types, regardless of whether the types are currently configured for harvesting. The set includes the WebLogic Server MBeans, which are always present, plus any other types that can be discovered. MBeans that are not WebLogic Server MBeans will require instances to exist in order to discover the type.
String[] getKnownHarvestableInstances(String type) throws HarvesterException.HarvestableTypesNotFoundException, HarvesterException.AmbiguousTypeName, HarvesterException.TypeNotHarvestable
The set of instances that are eligible for harvesting for the specified type at the time of the call. The type does not need to be currently configured for harvesting.
The caller should be aware that instances come and go. This method returns only those instances that exist at the time of the call.
For MBeans that are not WebLogic Server MBeans, returns null until at least one instance has been created.
type
- the name of the type to get the attributes for
HarvesterException.HarvestableTypesNotFoundException
- if the type
name is valid but could not be located
HarvesterException.AmbiguousTypeName
- if the
type name requires qualification to resolve
HarvesterException.TypeNotHarvestableException
- if the
type could never be harvested
HarvesterException.TypeNotHarvestable
String[] getCurrentlyHarvestedInstances(String type) throws HarvesterException.MissingConfigurationType, HarvesterException.HarvestingNotEnabled, HarvesterException.AmbiguousTypeName
The set of instances that are currently being harvested for the specified type. The type must be configured for harvesting.
The returned set of instances usually matches the corresponding set of instances configured for harvesting; but if an error occurs when harvesting an instance, that instance will be omitted from the returned set.
type
- the name of the type to get the instances for
HarvesterException.MissingConfigurationType
- if the provided type
is not configured for harvesting
HarvesterException.HarvestingNotEnabled
- if the Harvester is not
deployed
HarvesterException.AmbiguousTypeName
- if the
type name requires qualification to resolveString getHarvestableType(String instanceName) throws HarvesterException.HarvestableInstancesNotFoundException, HarvesterException.AmbiguousInstanceName
The type associated with a particular harvestable instance.
instanceName
- the name of the instance to get the type for
HarvesterException.HarvestableInstancesNotFoundException
- if
the provided instance does not currently exist
HarvesterException.AmbiguousInstanceName
- if the
instance name requires qualification to resolvelong getSamplePeriod() throws HarvesterException.HarvestingNotEnabled
The current global sample period, in nanoseconds.
HarvesterException.HarvestingNotEnabled
- if the Harvester is
not deployedlong getTotalSamplingCycles()
The total number of sampling cycles taken thus far.
long getMinimumSamplingTime()
The minimum sampling time, in nanoseconds.
long getMaximumSamplingTime()
The maximum sampling time, in nanoseconds.
long getTotalSamplingTime()
The total amount of time, in nanoseconds, spent in sampling cycles.
long getAverageSamplingTime()
The average amount of time, in nanoseconds, spent in sampling cycles.
long getTotalDataSampleCount() throws HarvesterException.HarvestingNotEnabled
The number of configured data samples that have been collected so far in this server session.
HarvesterException.HarvestingNotEnabled
- if the Harvester is
not deployedMap<String,MBeanAttributeInfo[]> getAttributeInfoForAllTypes()
This method returns all Harvester types and their MBeanAttributeInfos.
Map<String,ObjectName[]> getInstancesForAllTypes()
This method returns all Harvester types and their instances
long getCurrentDataSampleCount() throws HarvesterException.HarvestingNotEnabled
The number of collected data samples in the current snapshot.
HarvesterException.HarvestingNotEnabled
- if the Harvester is not deployedlong getCurrentSnapshotStartTime() throws HarvesterException.HarvestingNotEnabled
The start time, in nanoseconds, of a snapshot.
HarvesterException.HarvestingNotEnabled
- if the Harvester is not deployedlong getCurrentSnapshotElapsedTime() throws HarvesterException.HarvestingNotEnabled
The elapsed time, in nanoseconds, of a snapshot.
HarvesterException.HarvestingNotEnabled
- if the Harvester is not deployedlong getTotalSamplingTimeOutlierCount()
The number of times within this server session that the sampling time differed significantly enough from the average to be considered a statistical outlier. The Harvester removes these values form the ongoing averages.
boolean isCurrentSampleTimeAnOutlier()
Whether or not the sampling time for the most recent data sample differed significantly enough from the average to be considered a statistical outlier.
float getOutlierDetectionFactor()
The multiplicative factor used to determine a statistical outlier. If the actual sampling time exceeds this the session average multiplied by the outlier detection factor, then the sampling time is considered to be a statistical outlier.
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |