XMOJO 5 API Docs

javax.management.monitor
Interface CounterMonitorMBean

All Superinterfaces:
MonitorMBean
All Known Implementing Classes:
CounterMonitor

public interface CounterMonitorMBean
extends MonitorMBean

This interface exposes the remote management interface of the counter monitor MBean.


Method Summary
 java.lang.Number getDerivedGauge()
          This method gets the value of the derived gauge.
 long getDerivedGaugeTimeStamp()
          This method gets the value of the derived gauge time stamp.It is the time when the notification is triggered nearest to the milliseconds.
 boolean getDifferenceMode()
          This method gets the difference mode flag value.
 java.lang.Number getModulus()
          This method gets the modulus value.
 boolean getNotify()
          This method gets the notification's on/off switch value.
 java.lang.Number getOffset()
          This method gets offset value .
 java.lang.Number getThreshold()
          This method gets the threshold value .
 void setDifferenceMode(boolean value)
          This method sets the difference mode flag value.
 void setModulus(java.lang.Number value)
          This method sets the modulus value .
 void setNotify(boolean value)
          This method sets the notification's on/off switch value.
 void setOffset(java.lang.Number value)
          This method sets the offset value .
 void setThreshold(java.lang.Number value)
          This method sets the threshold value .
 
Methods inherited from interface javax.management.monitor.MonitorMBean
getGranularityPeriod, getObservedAttribute, getObservedObject, isActive, setGranularityPeriod, setObservedAttribute, setObservedObject, start, stop
 

Method Detail

getDerivedGauge

public java.lang.Number getDerivedGauge()
This method gets the value of the derived gauge.
Returns:
An instance of java.lang.Number giving the value of the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()
This method gets the value of the derived gauge time stamp.It is the time when the notification is triggered nearest to the milliseconds.
Returns:
The value of the derived gauge time Stamp.

getDifferenceMode

public boolean getDifferenceMode()
This method gets the difference mode flag value.
Returns:
true if the flag is on , false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)
This method sets the difference mode flag value.
Parameters:
true - if the difference mode is used, false otherwise.

getModulus

public java.lang.Number getModulus()
This method gets the modulus value.
Returns:
An instance of java.lang.Number giving the modulus value.

setModulus

public void setModulus(java.lang.Number value)
                throws java.lang.IllegalArgumentException
This method sets the modulus value .
Parameters:
value - An instance of java.lang.Number which is the modulus value.
Throws:
java.lang.IllegalArgumentException - - The specified modulus is null or the modulus value is less than zero.

getNotify

public boolean getNotify()
This method gets the notification's on/off switch value.
Returns:
true if the counter monitor notifies when exceeding the threshold, false otherwise.

setNotify

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

getOffset

public java.lang.Number getOffset()
This method gets offset value .
Returns:
An instance of java.lang.Number giving the offset value .

setOffset

public void setOffset(java.lang.Number value)
               throws java.lang.IllegalArgumentException
This method sets the offset value .
Parameters:
value - The offset value.

getThreshold

public java.lang.Number getThreshold()
This method gets the threshold value .
Returns:
An instance of java.lang.Number giving the threshold .

setThreshold

public void setThreshold(java.lang.Number value)
                  throws java.lang.IllegalArgumentException
This method sets the threshold value .
Parameters:
value - The Threshold Value.
Throws:
java.lang.IllegalArgumentException - - The specified threshold is null or the threshold value is less than zero.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.