|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.management.NotificationBroadcasterSupport
javax.management.monitor.Monitor
javax.management.monitor.GaugeMonitor
public class GaugeMonitor
Defines a monitor MBean designed to observe the values of a gauge attribute.
A gauge monitor observes an attribute that is continuously variable with time. A gauge monitor sends notifications as follows:
threshold high
notification is sent. The notify high flag must be set to
true
threshold low
notification is sent. The notify low flag must be set to
true.
If the gauge difference mode is used, the value of the derived
gauge is calculated as the difference between the observed gauge
values for two successive observations.
The derived gauge value (V[t]) is calculated using the following method:
Byte, Integer, Short,
Long, Float, Double).
| Field Summary |
|---|
| Fields inherited from class javax.management.monitor.Monitor |
|---|
alreadyNotified, alreadyNotifieds, capacityIncrement, dbgTag, elementCount, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED, OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED, OBSERVED_OBJECT_ERROR_NOTIFIED, RESET_FLAGS_ALREADY_NOTIFIED, RUNTIME_ERROR_NOTIFIED, server |
| Constructor Summary | |
|---|---|
GaugeMonitor()
Default constructor. |
|
| Method Summary | |
|---|---|
Number |
getDerivedGauge()
Deprecated. As of JMX 1.2, replaced by getDerivedGauge(ObjectName) |
Number |
getDerivedGauge(ObjectName object)
Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or null otherwise. |
long |
getDerivedGaugeTimeStamp()
Deprecated. As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName) |
long |
getDerivedGaugeTimeStamp(ObjectName object)
Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or null otherwise. |
boolean |
getDifferenceMode()
Gets the difference mode flag value common to all observed MBeans. |
Number |
getHighThreshold()
Gets the high threshold value common to all observed MBeans. |
Number |
getLowThreshold()
Gets the low threshold value common to all observed MBeans. |
MBeanNotificationInfo[] |
getNotificationInfo()
Returns a NotificationInfo object containing the
name of the Java class of the notification and the notification
types sent by the gauge monitor. |
boolean |
getNotifyHigh()
Gets the high notification's on/off switch value common to all observed MBeans. |
boolean |
getNotifyLow()
Gets the low notification's on/off switch value common to all observed MBeans. |
void |
setDifferenceMode(boolean value)
Sets the difference mode flag value common to all observed MBeans. |
void |
setGranularityPeriod(long period)
Sets the granularity period (in milliseconds). |
void |
setNotifyHigh(boolean value)
Sets the high notification's on/off switch value common to all observed MBeans. |
void |
setNotifyLow(boolean value)
Sets the low notification's on/off switch value common to all observed MBeans. |
void |
setThresholds(Number highValue,
Number lowValue)
Sets the high and the low threshold values common to all observed MBeans. |
void |
start()
Starts the gauge monitor. |
void |
stop()
Stops the gauge monitor. |
| Methods inherited from class javax.management.monitor.Monitor |
|---|
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, postDeregister, postRegister, preDeregister, preRegister, removeObservedObject, setObservedAttribute, setObservedObject |
| Methods inherited from class javax.management.NotificationBroadcasterSupport |
|---|
addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.management.monitor.MonitorMBean |
|---|
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setObservedAttribute, setObservedObject |
| Constructor Detail |
|---|
public GaugeMonitor()
| Method Detail |
|---|
public void start()
start in interface MonitorMBeanstart in class Monitorpublic void stop()
stop in interface MonitorMBeanstop in class Monitor
public void setGranularityPeriod(long period)
throws IllegalArgumentException
setGranularityPeriod in interface MonitorMBeansetGranularityPeriod in class Monitorperiod - The granularity period value.
IllegalArgumentException - The granularity
period is less than or equal to zero.Monitor.setGranularityPeriod(long)public Number getDerivedGauge(ObjectName object)
null otherwise.
getDerivedGauge in interface GaugeMonitorMBeanobject - the name of the MBean.
public long getDerivedGaugeTimeStamp(ObjectName object)
null otherwise.
getDerivedGaugeTimeStamp in interface GaugeMonitorMBeanobject - the name of the MBean.
@Deprecated public Number getDerivedGauge()
getDerivedGauge(ObjectName)
getDerivedGauge in interface GaugeMonitorMBean@Deprecated public long getDerivedGaugeTimeStamp()
getDerivedGaugeTimeStamp(ObjectName)
getDerivedGaugeTimeStamp in interface GaugeMonitorMBeanpublic Number getHighThreshold()
getHighThreshold in interface GaugeMonitorMBeanpublic Number getLowThreshold()
getLowThreshold in interface GaugeMonitorMBean
public void setThresholds(Number highValue,
Number lowValue)
throws IllegalArgumentException
setThresholds in interface GaugeMonitorMBeanhighValue - The high threshold value.lowValue - The low threshold value.
IllegalArgumentException - The specified high/low
threshold is null or the low threshold is greater than the high
threshold or the high threshold and the low threshold are not
of the same type.public boolean getNotifyHigh()
getNotifyHigh in interface GaugeMonitorMBeantrue if the gauge monitor notifies when
exceeding the high threshold, false otherwise.setNotifyHigh(boolean)public void setNotifyHigh(boolean value)
setNotifyHigh in interface GaugeMonitorMBeanvalue - The high notification's on/off switch value.getNotifyHigh()public boolean getNotifyLow()
getNotifyLow in interface GaugeMonitorMBeantrue if the gauge monitor notifies when
exceeding the low threshold, false otherwise.setNotifyLow(boolean)public void setNotifyLow(boolean value)
setNotifyLow in interface GaugeMonitorMBeanvalue - The low notification's on/off switch value.getNotifyLow()public boolean getDifferenceMode()
getDifferenceMode in interface GaugeMonitorMBeantrue if the difference mode is used,
false otherwise.setDifferenceMode(boolean)public void setDifferenceMode(boolean value)
setDifferenceMode in interface GaugeMonitorMBeanvalue - The difference mode flag value.getDifferenceMode()public MBeanNotificationInfo[] getNotificationInfo()
NotificationInfo object containing the
name of the Java class of the notification and the notification
types sent by the gauge monitor.
getNotificationInfo in interface NotificationBroadcastergetNotificationInfo in class NotificationBroadcasterSupport
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.