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

## javax.management.monitor
Interface GaugeMonitorMBean

All Superinterfaces:
  MonitorMBean

All Known Implementing Classes:
  GaugeMonitor

public interface GaugeMonitorMBean
extends MonitorMBean

Exposes the remote management interface of the gauge monitor MBean.

Author:
  Young Yang

Method Summary
`java.lang.Number` | `getDerivedGauge(ObjectName object)` Gets the derived gauge for the specified MBean.
`long` | `getDerivedGaugeTimeStamp(ObjectName object)` Gets the derived gauge timestamp for the specified MBean.
`boolean` | `getDifferenceMode()` Gets the difference mode flag value.
`java.lang.Number` | `getHighThreshold()` Gets the high threshold value.
`java.lang.Number` | `getLowThreshold()` Gets the low threshold value.
`boolean` | `getNotifyHigh()` Gets the high notification's on/off switch value.
`boolean` | `getNotifyLow()` Gets the low notification's on/off switch value.
`void` | `setDifferenceMode(boolean value)` Sets the difference mode flag value.
`void` | `setNotifyHigh(boolean value)` Sets the high notification's on/off switch value.
`void` | `setNotifyLow(boolean value)` Sets the low notification's on/off switch value.
`void` | `setThresholds(java.lang.Number highValue, java.lang.Number lowValue)` Sets the high and the low threshold values.

Methods inherited from interface javax.management.monitor.MonitorMBean
`addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute`

Method Detail

### getDerivedGauge

    public java.lang.Number getDerivedGauge(ObjectName object)

  Gets the derived gauge for the specified MBean.

  Parameters:
    `object` - the MBean for which the derived gauge is to be returned
  Returns:
    The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or `null` otherwise.
  Since:
    JMX 1.2

### getDerivedGaugeTimeStamp

    public long getDerivedGaugeTimeStamp(ObjectName object)

  Gets the derived gauge timestamp for the specified MBean.

  Parameters:
    `object` - the MBean for which the derived gauge timestamp is to be returned
  Returns:
    The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or `null` otherwise.
  Since:
    JMX 1.2

### getHighThreshold

    public java.lang.Number getHighThreshold()

  Gets the high threshold value.

  Returns:
    The high threshold value.

### getLowThreshold

    public java.lang.Number getLowThreshold()

  Gets the low threshold value.

  Returns:
    The low threshold value.

### setThresholds

    public void setThresholds(java.lang.Number highValue,
                              java.lang.Number lowValue)
                       throws java.lang.IllegalArgumentException

  Sets the high and the low threshold values.

  Parameters:
    `highValue` - The high threshold value.
    `lowValue` - The low threshold value.
  Throws:
    `java.lang.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.

### getNotifyHigh

    public boolean getNotifyHigh()

  Gets the high notification's on/off switch value.

  Returns:
    `true` if the gauge monitor notifies when exceeding the high threshold, `false` otherwise.
  See Also:
    `setNotifyHigh(boolean)`

### setNotifyHigh

    public void setNotifyHigh(boolean value)

  Sets the high notification's on/off switch value.

  Parameters:
    `value` - The high notification's on/off switch value.
  See Also:
    `getNotifyHigh()`

### getNotifyLow

    public boolean getNotifyLow()

  Gets the low notification's on/off switch value.

  Returns:
    `true` if the gauge monitor notifies when exceeding the low threshold, `false` otherwise.
  See Also:
    `setNotifyLow(boolean)`

### setNotifyLow

    public void setNotifyLow(boolean value)

  Sets the low notification's on/off switch value.

  Parameters:
    `value` - The low notification's on/off switch value.
  See Also:
    `getNotifyLow()`

### getDifferenceMode

    public boolean getDifferenceMode()

  Gets the difference mode flag value.

  Returns:
    `true` if the difference mode is used, `false` otherwise.
  See Also:
    `setDifferenceMode(boolean)`

### setDifferenceMode

    public void setDifferenceMode(boolean value)

  Sets the difference mode flag value.

  Parameters:
    `value` - The difference mode flag value.
  See Also:
    `getDifferenceMode()`

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