javax.management.monitor
Interface StringMonitorMBean

All Superinterfaces:
MonitorMBean (src)
All Known Implementing Classes:
StringMonitor (src)

public interface StringMonitorMBean
extends MonitorMBean (src)

The string monitor service MBean interface.


Method Summary
 java.lang.String getDerivedGauge()
          Deprecated. use getDerivedGauge(ObjectName)
 java.lang.String 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 getNotifyDiffer()
          Retrieves the differs on/off switch.
 boolean getNotifyMatch()
          Retrieves the matching on/off switch.
 java.lang.String getStringToCompare()
          Retrieves the string to compare with the observed attribute.
 void setNotifyDiffer(boolean value)
          Sets the differs on/off switch.
 void setNotifyMatch(boolean value)
          Sets the matching on/off switch.
 void setStringToCompare(java.lang.String value)
          Sets the string to compare with the observed attribute.
 
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.String 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.String 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.

getStringToCompare

public java.lang.String getStringToCompare()
Retrieves the string to compare with the observed attribute.

Returns:
the comparison string.

setStringToCompare

public void setStringToCompare(java.lang.String value)
                        throws java.lang.IllegalArgumentException
Sets the string to compare with the observed attribute.

Parameters:
value - the comparison string.
Throws:
java.lang.IllegalArgumentException - when specified string is null.

getNotifyMatch

public boolean getNotifyMatch()
Retrieves the matching on/off switch.

Returns:
true if the notification occurs when the string matches, false otherwise.

setNotifyMatch

public void setNotifyMatch(boolean value)
Sets the matching on/off switch.

Parameters:
value - pass true for a notification when the string matches, false otherwise.

getNotifyDiffer

public boolean getNotifyDiffer()
Retrieves the differs on/off switch.

Returns:
true if the notification occurs when the string differs, false otherwise.

setNotifyDiffer

public void setNotifyDiffer(boolean value)
Sets the differs on/off switch.

Parameters:
value - pass true for a notification when the string differs, false otherwise.