Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.management.monitor
Interface GaugeMonitorMBean

All Superinterfaces:
MonitorMBean (src)
All Known Implementing Classes:
GaugeMonitor (src)
public interface GaugeMonitorMBean
extends MonitorMBean (src)

The gauge monitor service MBean interface.

Method Summary
 java.lang.Number getDerivedGauge()
          Deprecated. use getDerivedGauge(ObjectName)
 java.lang.Number getDerivedGauge(ObjectName (src)  name)
          Retrieves the derived gauge.
 long getDerivedGaugeTimeStamp()
          Deprecated. use getDerivedGaugeTimeStamp(ObjectName)
 long getDerivedGaugeTimeStamp(ObjectName (src)  name)
          Retrieves the derived gauge timestamp.
 boolean getDifferenceMode()
          Retrieves the difference mode flag.
 java.lang.Number getHighThreshold()
          Retrieves the high threshold.
 java.lang.Number getLowThreshold()
          Retrieves the low threshold.
 boolean getNotifyHigh()
          Retrieves the high notify on/off switch.
 boolean getNotifyLow()
          Retrieves the low notify on/off switch.
 void setDifferenceMode(boolean value)
          Sets the difference mode flag.
 void setNotifyHigh(boolean value)
          Sets the high notify on/off switch.
 void setNotifyLow(boolean value)
          Sets the low notify on/off switch.
 void setThresholds(java.lang.Number highValue, java.lang.Number lowValue)
          Sets the high and low threshold.
 
Methods inherited from interface javax.management.monitor.MonitorMBean (src)
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject, start, stop
 

Method Detail

getDerivedGauge

public java.lang.Number getDerivedGauge()
Deprecated. use getDerivedGauge(ObjectName)

Retrieves the derived gauge.

Returns:
the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()
Deprecated. use getDerivedGaugeTimeStamp(ObjectName)

Retrieves the derived gauge timestamp.

Returns:
the derived gauge timestamp.

getDerivedGauge

public java.lang.Number getDerivedGauge(ObjectName (src)  name)
Retrieves the derived gauge.

Parameters:
name - the object name of the mbean.
Returns:
the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp(ObjectName (src)  name)
Retrieves the derived gauge timestamp.

Parameters:
name - the object name of the mbean.
Returns:
the derived gauge timestamp.

getHighThreshold

public java.lang.Number getHighThreshold()
Retrieves the high threshold. REVIEW: zero threshold

Returns:
the high threshold value, zero means no threshold.

getLowThreshold

public java.lang.Number getLowThreshold()
Retrieves the low threshold. REVIEW: zero threshold

Returns:
the low threshold value, zero means no threshold.

setThresholds

public void setThresholds(java.lang.Number highValue,
                          java.lang.Number lowValue)
                   throws java.lang.IllegalArgumentException
Sets the high and low threshold. REVIEW: zero threshold

Parameters:
highValue - the high threshold value, pass zero for no high threshold.
lowValue - the low threshold value, pass zero for no low threshold.
Throws:
java.lang.IllegalArgumentException - when either threshold is null or the high threshold is lower than the low threshold or the. thresholds have different types.

getNotifyHigh

public boolean getNotifyHigh()
Retrieves the high notify on/off switch.

Returns:
true if high notifications occur, false otherwise.

setNotifyHigh

public void setNotifyHigh(boolean value)
Sets the high notify on/off switch.

Parameters:
value - pass true for high notifications, false otherwise.

getNotifyLow

public boolean getNotifyLow()
Retrieves the low notify on/off switch.

Returns:
true if low notifications occur, false otherwise.

setNotifyLow

public void setNotifyLow(boolean value)
Sets the low notify on/off switch.

Parameters:
value - pass true for low notifications, false otherwise.

getDifferenceMode

public boolean getDifferenceMode()
Retrieves the difference mode flag.

Returns:
true when in difference mode, false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)
Sets the difference mode flag.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD