Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

weblogic.management.runtime
Interface WLDFHarvesterRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, WebLogicMBean

public interface WLDFHarvesterRuntimeMBean

extends weblogic.management.runtime.RuntimeMBean

Provides information 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.

Since:

9.0.0.0

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary

long	getAverageSamplingTime() The average amount of time, in nanoseconds, spent in sampling cycles.
long	getCurrentDataSampleCount() The number of collected data samples in the current snapshot.
String[]	getCurrentlyHarvestedAttributes(String type) The set of attributes that are currently being harvested for the specified type.
String[]	getCurrentlyHarvestedInstances(String type) The set of instances that are currently being harvested for the specified type.
long	getCurrentSnapshotElapsedTime() The elapsed time, in nanoseconds, of a snapshot.
long	getCurrentSnapshotStartTime() The start time, in nanoseconds, of a snapshot.
String[][]	getHarvestableAttributes(String type) The set of attributes that are eligible for harvesting for the specified type.
String	getHarvestableType(String instanceName) The type associated with a particular harvestable instance.
String[]	getKnownHarvestableInstances(String type) The set of instances that are eligible for harvesting for the specified type at the time of the call.
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() The multiplicative factor used to determine a statistical outlier.
long	getSamplePeriod() The current global sample period, in nanoseconds.
long	getTotalDataSampleCount() The number of configured data samples that have been collected so far in this server session.
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() The number of times withing this server session that the sampling time differed significantly enough from the average to be considered a statistical outlier.
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.

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

getAverageSamplingTime

public long getAverageSamplingTime()

The average amount of time, in nanoseconds, spent in sampling cycles.

Returns:

the average amount of time spent (in nanoseconds) in sampling cycles

getCurrentDataSampleCount

public long getCurrentDataSampleCount()
                               throws weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled

The number of collected data samples in the current snapshot.

Returns:

the number of data samples collected in the current snapshot

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getCurrentlyHarvestedAttributes

public String[] getCurrentlyHarvestedAttributes(String type)
                                         throws weblogic.diagnostics.harvester.HarvesterException.MissingConfigurationType,
                                                weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled,
                                                weblogic.diagnostics.harvester.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.

Parameters:

type - the name of the type to get the attributes for

Returns:

the set of attributes currently being harvested for the provided type

Throws:

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

weblogic.diagnostics.harvester.HarvesterException.AmbiguousTypeName

getCurrentlyHarvestedInstances

public String[] getCurrentlyHarvestedInstances(String type)
                                        throws weblogic.diagnostics.harvester.HarvesterException.MissingConfigurationType,
                                               weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled,
                                               weblogic.diagnostics.harvester.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.

Parameters:

type - the name of the type to get the instances for

Returns:

the set of instances currently being harvested for the provided type

Throws:

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 resolve

getCurrentSnapshotElapsedTime

public long getCurrentSnapshotElapsedTime()
                                   throws weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled

The elapsed time, in nanoseconds, of a snapshot.

Returns:

the elapsed time (in nanoseconds) of the most recent snapshot

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getCurrentSnapshotStartTime

public long getCurrentSnapshotStartTime()
                                 throws weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled

The start time, in nanoseconds, of a snapshot.

Returns:

the start time in nanoseconds

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getHarvestableAttributes

public String[][] getHarvestableAttributes(String type)
                                    throws weblogic.diagnostics.harvester.HarvesterException.HarvestableTypesNotFoundException,
                                           weblogic.diagnostics.harvester.HarvesterException.AmbiguousTypeName,
                                           weblogic.diagnostics.harvester.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.

Parameters:

type - the name of the type to get the attributes for

Returns:

the set of attributes that are eligible for harvesting for the specified type

Throws:

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

weblogic.diagnostics.harvester.HarvesterException.TypeNotHarvestable

getHarvestableType

public String getHarvestableType(String instanceName)
                          throws weblogic.diagnostics.harvester.HarvesterException.HarvestableInstancesNotFoundException,
                                 weblogic.diagnostics.harvester.HarvesterException.AmbiguousInstanceName

The type associated with a particular harvestable instance.

Parameters:

instanceName - the name of the instance to get the type for

Returns:

the name of the associated type, or null if the instance does not exist

Throws:

HarvesterException.HarvestableInstancesNotFoundException - if the provided instance does not currently exist

HarvesterException.AmbiguousInstanceName - if the instance name requires qualification to resolve

getKnownHarvestableInstances

public String[] getKnownHarvestableInstances(String type)
                                      throws weblogic.diagnostics.harvester.HarvesterException.HarvestableTypesNotFoundException,
                                             weblogic.diagnostics.harvester.HarvesterException.AmbiguousTypeName,
                                             weblogic.diagnostics.harvester.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.

Note

For MBeans that are not WebLogic Server MBeans, returns null until at least one instance has been created.

Parameters:

type - the name of the type to get the attributes for

Returns:

the set of instances that are eligible for harvesting for the provided type at the time of the call

Throws:

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

weblogic.diagnostics.harvester.HarvesterException.TypeNotHarvestable

getKnownHarvestableTypes

public 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.

Returns:

the set of known types

getMaximumSamplingTime

public long getMaximumSamplingTime()

The maximum sampling time, in nanoseconds.

Returns:

the maximum sampling time in nanoseconds

getMinimumSamplingTime

public long getMinimumSamplingTime()

The minimum sampling time, in nanoseconds.

Returns:

the minimum sampling time in nanoseconds

getOutlierDetectionFactor

public 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.

Returns:

the multiplicative factor used to identify outliers

getSamplePeriod

public long getSamplePeriod()
                     throws weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled

The current global sample period, in nanoseconds.

Returns:

the current global sample period in nanoseconds

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getTotalDataSampleCount

public long getTotalDataSampleCount()
                             throws weblogic.diagnostics.harvester.HarvesterException.HarvestingNotEnabled

The number of configured data samples that have been collected so far in this server session.

Returns:

the number of configured data samples collected in this server session

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getTotalSamplingCycles

public long getTotalSamplingCycles()

The total number of sampling cycles taken thus far.

Returns:

the number of sampling cycles taken

getTotalSamplingTime

public long getTotalSamplingTime()

The total amount of time, in nanoseconds, spent in sampling cycles.

Returns:

the total amount of time spent (in nanoseconds) in all sampling cycles

getTotalSamplingTimeOutlierCount

public long getTotalSamplingTimeOutlierCount()

The number of times withing 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.

Returns:

the count of statistical outliers since the start of the session

isCurrentSampleTimeAnOutlier

public 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.

Returns:

Whether the most recent sampling time was an outlier