XMOJO 5 API Docs

javax.management.monitor
Interface StringMonitorMBean

All Superinterfaces:
MonitorMBean
All Known Implementing Classes:
StringMonitor

public interface StringMonitorMBean
extends MonitorMBean

Exposes the remote management interface of the string monitor MBean.


Method Summary
 java.lang.String getDerivedGauge()
          This method gets the value of the derived gauge.
 long getDerivedGaugeTimeStamp()
          This method gets the value of the derived gauge time stamp.
 boolean getNotifyDiffer()
          This method sets the differing notification's on/off switch value.
 boolean getNotifyMatch()
          This method gets the matching notification's on/off switch value.
 java.lang.String getStringToCompare()
          This method gets the string to compare with the observed attribute.
 void setNotifyDiffer(boolean value)
          This method sets the differing notification's on/off switch value.
 void setNotifyMatch(boolean value)
          This method sets the matching notification's on/off switch value.
 void setStringToCompare(java.lang.String value)
          This method sets the string to compare with the observed attribute.
 
Methods inherited from interface javax.management.monitor.MonitorMBean
getGranularityPeriod, getObservedAttribute, getObservedObject, isActive, setGranularityPeriod, setObservedAttribute, setObservedObject, start, stop
 

Method Detail

getDerivedGauge

public java.lang.String getDerivedGauge()
This method gets the value of the derived gauge. The derived gauge is either the exact value of the observed attribute, or the difference between the two consecutive observed values of the attribute.
Returns:
An instance of java.lang.String giving the value of the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()
This method gets the value of the derived gauge time stamp. The derived gauge time stamp is the value(in the nearest miliseconds) when the notification was triggered.
Returns:
long value representing the time the notification was triggered.

getNotifyDiffer

public boolean getNotifyDiffer()
This method sets the differing notification's on/off switch value.
Returns:
The differing notification's on/off switch value.

setNotifyDiffer

public void setNotifyDiffer(boolean value)
This method sets the differing notification's on/off switch value.
Parameters:
value - - The differing notification's on/off switch value.

getNotifyMatch

public boolean getNotifyMatch()
This method gets the matching notification's on/off switch value.
Returns:
The matching notification's on/off switch value.

setNotifyMatch

public void setNotifyMatch(boolean value)
This method sets the matching notification's on/off switch value.
Parameters:
value - - The matching notification's on/off switch value.

getStringToCompare

public java.lang.String getStringToCompare()
This method gets the string to compare with the observed attribute.
Returns:
the String to be compared.

setStringToCompare

public void setStringToCompare(java.lang.String value)
                        throws java.lang.IllegalArgumentException
This method sets the string to compare with the observed attribute.
Parameters:
value - The String Value to be compared.
Throws:
java.lang.IllegalArgumentException - - The specified string to compare is null.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.