Class: javax.management.monitor.CounterMonitor
- public class CounterMonitor
- extends Monitor
- implements CounterMonitorMBean
A counter monitor sends a threshold
notification when the value of the counter reaches or exceeds a
threshold known as the comparison level. The notify flag must be
set to true.
In addition, an offset mechanism enables particular counting intervals to be detected. If the offset value is not zero, whenever the threshold is triggered by the counter value reaching a comparison level, that comparison level is incremented by the offset value. This is regarded as taking place instantaneously, that is, before the count is incremented. Thus, for each level, the threshold triggers an event notification every time the count increases by an interval equal to the offset value.
If the counter can wrap around its maximum value, the modulus needs to be specified. The modulus is the value at which the counter is reset to zero.
If the counter difference mode is used, the value of the derived gauge is calculated as the difference between the observed counter values for two successive observations. If this difference is negative, the value of the derived gauge is incremented by the value of the modulus. The derived gauge value (V[t]) is calculated using the following method:
- if (counter[t] - counter[t-GP]) is positive then V[t] = counter[t] - counter[t-GP]
- if (counter[t] - counter[t-GP]) is negative then V[t] = counter[t] - counter[t-GP] + MODULUS
Byte,
Integer, Short, Long).Inheritance
Superclass tree:- java.lang.Object
- javax.management.NotificationBroadcasterSupport
- javax.management.monitor.Monitor
- javax.management.monitor.CounterMonitor
Methods
-
CounterMonitortop
public CounterMonitor()Default constructor. -
getDerivedGaugetop
public synchronized Number getDerivedGauge()Returns the derived gauge of the first object in the set of observed MBeans.- Specified by:
- getDerivedGauge from CounterMonitorMBean
-
getDerivedGaugetop
Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, ornullotherwise.- Specified by:
- getDerivedGauge from CounterMonitorMBean
-
getDerivedGaugeTimeStamptop
public synchronized long getDerivedGaugeTimeStamp()Gets the derived gauge timestamp of the first object in the set of observed MBeans.- Specified by:
- getDerivedGaugeTimeStamp from CounterMonitorMBean
-
getDerivedGaugeTimeStamptop
public synchronized long getDerivedGaugeTimeStamp(ObjectName object)Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or0otherwise.- Specified by:
- getDerivedGaugeTimeStamp from CounterMonitorMBean
-
getDifferenceModetop
public synchronized boolean getDifferenceMode()Gets the difference mode flag value common to all observed MBeans.- Specified by:
- getDifferenceMode from CounterMonitorMBean
-
getInitThresholdtop
public synchronized Number getInitThreshold()Gets the initial threshold value common to all observed objects.- Specified by:
- getInitThreshold from CounterMonitorMBean
-
getModulustop
public synchronized Number getModulus()Gets the modulus value common to all observed MBeans.- Specified by:
- getModulus from CounterMonitorMBean
-
getNotificationInfotop
public MBeanNotificationInfo[] getNotificationInfo()Returns aNotificationInfoobject containing the name of the Java class of the notification and the notification types sent by the counter monitor.- Specified by:
- getNotificationInfo from NotificationBroadcaster
- Override hierarchy:
- getNotificationInfo from NotificationBroadcasterSupport
-
getNotifytop
public synchronized boolean getNotify()Gets the notification's on/off switch value common to all observed MBeans.- Specified by:
- getNotify from CounterMonitorMBean
-
getOffsettop
public synchronized Number getOffset()Gets the offset value common to all observed MBeans.- Specified by:
- getOffset from CounterMonitorMBean
-
getThresholdtop
public synchronized Number getThreshold()Gets the threshold value of the first object in the set of observed MBeans.- Specified by:
- getThreshold from CounterMonitorMBean
-
getThresholdtop
public synchronized Number getThreshold(ObjectName object)Gets the current threshold value of the specified object, if this object is contained in the set of observed MBeans, ornullotherwise.- Specified by:
- getThreshold from CounterMonitorMBean
-
setDifferenceModetop
public synchronized void setDifferenceMode(boolean value)Sets the difference mode flag value common to all observed MBeans.- Specified by:
- setDifferenceMode from CounterMonitorMBean
-
setInitThresholdtop
public synchronized void setInitThreshold(Number value) throws IllegalArgumentExceptionSets the initial threshold value common to all observed objects.
The current threshold of every object in the set of observed MBeans is updated consequently.- Specified by:
- setInitThreshold from CounterMonitorMBean
-
setModulustop
public synchronized void setModulus(Number value) throws IllegalArgumentExceptionSets the modulus value common to all observed MBeans.- Specified by:
- setModulus from CounterMonitorMBean
-
setNotifytop
public synchronized void setNotify(boolean value)Sets the notification's on/off switch value common to all observed MBeans.- Specified by:
- setNotify from CounterMonitorMBean
-
setOffsettop
public synchronized void setOffset(Number value) throws IllegalArgumentExceptionSets the offset value common to all observed MBeans.- Specified by:
- setOffset from CounterMonitorMBean
-
setThresholdtop
Sets the initial threshold value.- Specified by:
- setThreshold from CounterMonitorMBean
-
starttop
public synchronized void start()Starts the counter monitor.- Specified by:
- start from MonitorMBean
-
stoptop
public synchronized void stop()Stops the counter monitor.- Specified by:
- stop from MonitorMBean
