All Packages Class Hierarchy This Package Previous Next Index
Class com.sun.jaw.impl.agent.services.monitor.GaugeMonitor
java.lang.Object
|
+----com.sun.jaw.impl.agent.services.monitor.Monitor
|
+----com.sun.jaw.impl.agent.services.monitor.GaugeMonitor
- public class GaugeMonitor
- extends Monitor
- implements AlarmClockListener, Serializable
This class provides a simple implementation of a gauge monitor.
A gauge monitor is a monitor which observes an attribute which behaves as a gauge.
A hysteresis mechanism is provided to avoid the repeated triggering of event notifications
when the gauge makes small oscillations around the threshold value. This capability is
provided by specifying threshold values in pairs; one being a high threshold value
and the other being a low threshold value. The difference between threshold values
is the hysteresis interval.
The gauge monitor has the following structure:
- The threshold high value property defines the value that the gauge must reach or
exceed in order to optionally generate an event notification, together with a notify
high on/off property, whose value controls the generation of the event notification.
- The threshold low value property defines the value that the gauge must fall to or
below in order to optionally generate an event notification, together with a notify
low on/off property, whose value controls the generation of the event notification.
The gauge monitor has the following constraints:
- The threshold high value and the threshold low value properties are of the same
type as the observed property.
- The threshold high value is greater or equal to the threshold low value.
The gauge monitor has the following behaviour:
- initially, if notify-high's on/off switch is true and the gauge value becomes equal
to or greater than threshold high value, in a positive going direction, then the defined
event notification is triggered; subsequent crossings of threshold high value shall not
cause further generation of event reports unless the gauge value becomes equal to or less
than threshold low value.
- initially, if notify-low's on/off switch is true and the gauge value becomes equal
to or less than threshold low value, in a negative going direction, then the defined
event notification is triggered; subsequent crossings of threshold low value shall not
cause further generation of event reports unless the gauge value becomes equal to or greater
than threshold high value.
If the gauge difference option is used, then 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 initially calculated using the following equation:
- V[t] = gauge[t] - gauge[t-GP]
This implementation of the gauge monitor requires the observed property to be either of type
Integer or Float.
- See Also:
- Monitor, CounterMonitor
-
GaugeMonitor()
-
-
getGaugeDifferenceOnOff()
- Returns the gauge difference on/off flag.
-
getNotifyHighOnOff()
- Returns the notify high on/off switch value.
-
getNotifyLowOnOff()
- Returns the notify low on/off switch value.
-
getPreviousScanGauge()
- Returns the previous scan gauge.
-
getPreviousScanGaugeInitialisedOnOff()
- Returns the previous scan gauge procedural status.
-
getThresholdHighValue()
- Returns the threshold high value.
-
getThresholdLowValue()
- Returns the threshold low value.
-
handleAlarmClock(AlarmClockEvent)
- This handle will be called each time the alarm-clock has exceeded its timeout.
-
performStart()
- Activates the
GaugeMonitor service.
-
performStop()
- Deactivates the
GaugeMonitor service.
-
setGaugeDifferenceOnOff(Boolean)
- Sets the gauge difference on/off flag.
-
setNotifyHighOnOff(Boolean)
- Sets the notify high on/off switch value.
-
setNotifyLowOnOff(Boolean)
- Sets the notify low on/off switch value.
-
setThresholdHighValue(Number)
- Sets the threshold high value.
-
setThresholdLowValue(Number)
- Sets the threshold low value.
GaugeMonitor
public GaugeMonitor()
handleAlarmClock
public void handleAlarmClock(AlarmClockEvent e)
- This handle will be called each time the alarm-clock has exceeded its timeout.
- Overrides:
- handleAlarmClock in class Monitor
getThresholdHighValue
public Number getThresholdHighValue()
- Returns the threshold high value.
setThresholdHighValue
public void setThresholdHighValue(Number value)
- Sets the threshold high value.
getThresholdLowValue
public Number getThresholdLowValue()
- Returns the threshold low value.
setThresholdLowValue
public void setThresholdLowValue(Number value)
- Sets the threshold low value.
getNotifyHighOnOff
public Boolean getNotifyHighOnOff()
- Returns the notify high on/off switch value.
setNotifyHighOnOff
public void setNotifyHighOnOff(Boolean value)
- Sets the notify high on/off switch value.
getNotifyLowOnOff
public Boolean getNotifyLowOnOff()
- Returns the notify low on/off switch value.
setNotifyLowOnOff
public void setNotifyLowOnOff(Boolean value)
- Sets the notify low on/off switch value.
getGaugeDifferenceOnOff
public Boolean getGaugeDifferenceOnOff()
- Returns the gauge difference on/off flag.
setGaugeDifferenceOnOff
public void setGaugeDifferenceOnOff(Boolean value)
- Sets the gauge difference on/off flag.
getPreviousScanGauge
public Number getPreviousScanGauge()
- Returns the previous scan gauge.
getPreviousScanGaugeInitialisedOnOff
public Boolean getPreviousScanGaugeInitialisedOnOff()
- Returns the previous scan gauge procedural status.
performStart
public synchronized void performStart()
- Activates the
GaugeMonitor service.
- Overrides:
- performStart in class Monitor
performStop
public synchronized void performStop()
- Deactivates the
GaugeMonitor service.
- Overrides:
- performStop in class Monitor
All Packages Class Hierarchy This Package Previous Next Index