- java.lang.Object
- 
- javax.management.NotificationBroadcasterSupport
- 
- javax.management.monitor.Monitor
- 
- javax.management.monitor.CounterMonitor
 
 
 
- 
- All Implemented Interfaces:
- MBeanRegistration,- CounterMonitorMBean,- MonitorMBean,- NotificationBroadcaster,- NotificationEmitter
 
 public class CounterMonitor extends Monitor implements CounterMonitorMBean Defines a monitor MBean designed to observe the values of a counter attribute.A counter monitor sends a threshold notificationwhen the value of the counter reaches or exceeds a threshold known as the comparison level. The notify flag must be set totrue.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).- Since:
- 1.5
 
- 
- 
Field Summary- 
Fields declared in class javax.management.monitor.MonitoralreadyNotified, alreadyNotifieds, capacityIncrement, dbgTag, elementCount, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED, OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED, OBSERVED_OBJECT_ERROR_NOTIFIED, RESET_FLAGS_ALREADY_NOTIFIED, RUNTIME_ERROR_NOTIFIED, server
 
- 
 - 
Constructor SummaryConstructors Constructor Description CounterMonitor()Default constructor.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NumbergetDerivedGauge()Deprecated.As of JMX 1.2, replaced bygetDerivedGauge(ObjectName)NumbergetDerivedGauge(ObjectName object)Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, ornullotherwise.longgetDerivedGaugeTimeStamp()Deprecated.As of JMX 1.2, replaced bygetDerivedGaugeTimeStamp(ObjectName)longgetDerivedGaugeTimeStamp(ObjectName object)Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or0otherwise.booleangetDifferenceMode()Gets the difference mode flag value common to all observed MBeans.NumbergetInitThreshold()Gets the initial threshold value common to all observed objects.NumbergetModulus()Gets the modulus value common to all observed MBeans.MBeanNotificationInfo[]getNotificationInfo()Returns aNotificationInfoobject containing the name of the Java class of the notification and the notification types sent by the counter monitor.booleangetNotify()Gets the notification's on/off switch value common to all observed MBeans.NumbergetOffset()Gets the offset value common to all observed MBeans.NumbergetThreshold()Deprecated.As of JMX 1.2, replaced bygetThreshold(ObjectName)NumbergetThreshold(ObjectName object)Gets the current threshold value of the specified object, if this object is contained in the set of observed MBeans, ornullotherwise.voidsetDifferenceMode(boolean value)Sets the difference mode flag value common to all observed MBeans.voidsetInitThreshold(Number value)Sets the initial threshold value common to all observed objects.voidsetModulus(Number value)Sets the modulus value common to all observed MBeans.voidsetNotify(boolean value)Sets the notification's on/off switch value common to all observed MBeans.voidsetOffset(Number value)Sets the offset value common to all observed MBeans.voidsetThreshold(Number value)Deprecated.As of JMX 1.2, replaced bysetInitThreshold(java.lang.Number)voidstart()Starts the counter monitor.voidstop()Stops the counter monitor.- 
Methods declared in class javax.management.monitor.MonitoraddObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, postDeregister, postRegister, preDeregister, preRegister, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject
 - 
Methods declared in class javax.management.NotificationBroadcasterSupportaddNotificationListener, handleNotification, sendNotification
 - 
Methods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods declared in interface javax.management.monitor.MonitorMBeanaddObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject
 - 
Methods declared in interface javax.management.NotificationBroadcasterremoveNotificationListener
 - 
Methods declared in interface javax.management.NotificationEmitterremoveNotificationListener
 
- 
 
- 
- 
- 
Method Detail- 
startpublic void start() Starts the counter monitor.- Specified by:
- startin interface- MonitorMBean
- Specified by:
- startin class- Monitor
 
 - 
stoppublic void stop() Stops the counter monitor.- Specified by:
- stopin interface- MonitorMBean
- Specified by:
- stopin class- Monitor
 
 - 
getDerivedGaugepublic Number getDerivedGauge(ObjectName object) Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, ornullotherwise.- Specified by:
- getDerivedGaugein interface- CounterMonitorMBean
- Parameters:
- object- the name of the object whose derived gauge is to be returned.
- Returns:
- The derived gauge of the specified object.
 
 - 
getDerivedGaugeTimeStamppublic 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:
- getDerivedGaugeTimeStampin interface- CounterMonitorMBean
- Parameters:
- object- the name of the object whose derived gauge timestamp is to be returned.
- Returns:
- The derived gauge timestamp of the specified object.
 
 - 
getThresholdpublic 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:
- getThresholdin interface- CounterMonitorMBean
- Parameters:
- object- the name of the object whose threshold is to be returned.
- Returns:
- The threshold value of the specified object.
- See Also:
- CounterMonitorMBean.setThreshold(java.lang.Number)
 
 - 
getInitThresholdpublic Number getInitThreshold() Gets the initial threshold value common to all observed objects.- Specified by:
- getInitThresholdin interface- CounterMonitorMBean
- Returns:
- The initial threshold.
- See Also:
- setInitThreshold(java.lang.Number)
 
 - 
setInitThresholdpublic void setInitThreshold(Number value) throws IllegalArgumentException Sets 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:
- setInitThresholdin interface- CounterMonitorMBean
- Parameters:
- value- The initial threshold value.
- Throws:
- IllegalArgumentException- The specified threshold is null or the threshold value is less than zero.
- See Also:
- getInitThreshold()
 
 - 
getDerivedGauge@Deprecated public Number getDerivedGauge() Deprecated.As of JMX 1.2, replaced bygetDerivedGauge(ObjectName)Returns the derived gauge of the first object in the set of observed MBeans.- Specified by:
- getDerivedGaugein interface- CounterMonitorMBean
- Returns:
- The derived gauge.
 
 - 
getDerivedGaugeTimeStamp@Deprecated public long getDerivedGaugeTimeStamp() Deprecated.As of JMX 1.2, replaced bygetDerivedGaugeTimeStamp(ObjectName)Gets the derived gauge timestamp of the first object in the set of observed MBeans.- Specified by:
- getDerivedGaugeTimeStampin interface- CounterMonitorMBean
- Returns:
- The derived gauge timestamp.
 
 - 
getThreshold@Deprecated public Number getThreshold() Deprecated.As of JMX 1.2, replaced bygetThreshold(ObjectName)Gets the threshold value of the first object in the set of observed MBeans.- Specified by:
- getThresholdin interface- CounterMonitorMBean
- Returns:
- The threshold value.
- See Also:
- setThreshold(java.lang.Number)
 
 - 
setThreshold@Deprecated public void setThreshold(Number value) throws IllegalArgumentException Deprecated.As of JMX 1.2, replaced bysetInitThreshold(java.lang.Number)Sets the initial threshold value.- Specified by:
- setThresholdin interface- CounterMonitorMBean
- Parameters:
- value- The initial threshold value.
- Throws:
- IllegalArgumentException- The specified threshold is null or the threshold value is less than zero.
- See Also:
- getThreshold()
 
 - 
getOffsetpublic Number getOffset() Gets the offset value common to all observed MBeans.- Specified by:
- getOffsetin interface- CounterMonitorMBean
- Returns:
- The offset value.
- See Also:
- setOffset(java.lang.Number)
 
 - 
setOffsetpublic void setOffset(Number value) throws IllegalArgumentException Sets the offset value common to all observed MBeans.- Specified by:
- setOffsetin interface- CounterMonitorMBean
- Parameters:
- value- The offset value.
- Throws:
- IllegalArgumentException- The specified offset is null or the offset value is less than zero.
- See Also:
- getOffset()
 
 - 
getModuluspublic Number getModulus() Gets the modulus value common to all observed MBeans.- Specified by:
- getModulusin interface- CounterMonitorMBean
- Returns:
- The modulus value.
- See Also:
- setModulus(java.lang.Number)
 
 - 
setModuluspublic void setModulus(Number value) throws IllegalArgumentException Sets the modulus value common to all observed MBeans.- Specified by:
- setModulusin interface- CounterMonitorMBean
- Parameters:
- value- The modulus value.
- Throws:
- IllegalArgumentException- The specified modulus is null or the modulus value is less than zero.
- See Also:
- getModulus()
 
 - 
getNotifypublic boolean getNotify() Gets the notification's on/off switch value common to all observed MBeans.- Specified by:
- getNotifyin interface- CounterMonitorMBean
- Returns:
- trueif the counter monitor notifies when exceeding the threshold,- falseotherwise.
- See Also:
- setNotify(boolean)
 
 - 
setNotifypublic void setNotify(boolean value) Sets the notification's on/off switch value common to all observed MBeans.- Specified by:
- setNotifyin interface- CounterMonitorMBean
- Parameters:
- value- The notification's on/off switch value.
- See Also:
- getNotify()
 
 - 
getDifferenceModepublic boolean getDifferenceMode() Gets the difference mode flag value common to all observed MBeans.- Specified by:
- getDifferenceModein interface- CounterMonitorMBean
- Returns:
- trueif the difference mode is used,- falseotherwise.
- See Also:
- setDifferenceMode(boolean)
 
 - 
setDifferenceModepublic void setDifferenceMode(boolean value) Sets the difference mode flag value common to all observed MBeans.- Specified by:
- setDifferenceModein interface- CounterMonitorMBean
- Parameters:
- value- The difference mode flag value.
- See Also:
- getDifferenceMode()
 
 - 
getNotificationInfopublic 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:
- getNotificationInfoin interface- NotificationBroadcaster
- Returns:
- the array of possible notifications.
 
 
- 
 
-