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
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:
Byte, Integer, Short, Long).alreadyNotified, 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 public CounterMonitor()
Default constructor.
public void start()
Starts the counter monitor.
start in interface MonitorMBean
start in class Monitor
public void stop()
Stops the counter monitor.
stop in interface MonitorMBean
stop in class Monitor
public Number getDerivedGauge(ObjectName object)
Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or null otherwise.
getDerivedGauge in interface CounterMonitorMBean
object - the name of the object whose derived gauge is to be returned.public long getDerivedGaugeTimeStamp(ObjectName object)
Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or 0 otherwise.
getDerivedGaugeTimeStamp in interface CounterMonitorMBean
object - the name of the object whose derived gauge timestamp is to be returned.public Number getThreshold(ObjectName object)
Gets the current threshold value of the specified object, if this object is contained in the set of observed MBeans, or null otherwise.
getThreshold in interface CounterMonitorMBean
object - the name of the object whose threshold is to be returned.CounterMonitorMBean.setThreshold(java.lang.Number)public Number getInitThreshold()
Gets the initial threshold value common to all observed objects.
getInitThreshold in interface CounterMonitorMBean
setInitThreshold(java.lang.Number)public 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.
setInitThreshold in interface CounterMonitorMBean
value - The initial threshold value.IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.getInitThreshold()@Deprecated public Number getDerivedGauge()
Deprecated. As of JMX 1.2, replaced by getDerivedGauge(ObjectName)
Returns the derived gauge of the first object in the set of observed MBeans.
getDerivedGauge in interface CounterMonitorMBean
@Deprecated public long getDerivedGaugeTimeStamp()
Deprecated. As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)
Gets the derived gauge timestamp of the first object in the set of observed MBeans.
getDerivedGaugeTimeStamp in interface CounterMonitorMBean
@Deprecated public Number getThreshold()
Deprecated. As of JMX 1.2, replaced by getThreshold(ObjectName)
Gets the threshold value of the first object in the set of observed MBeans.
getThreshold in interface CounterMonitorMBean
setThreshold(java.lang.Number)@Deprecated
public void setThreshold(Number value)
throws IllegalArgumentException Deprecated. As of JMX 1.2, replaced by setInitThreshold(java.lang.Number)
Sets the initial threshold value.
setThreshold in interface CounterMonitorMBean
value - The initial threshold value.IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.getThreshold()public Number getOffset()
Gets the offset value common to all observed MBeans.
getOffset in interface CounterMonitorMBean
setOffset(java.lang.Number)public void setOffset(Number value)
throws IllegalArgumentException Sets the offset value common to all observed MBeans.
setOffset in interface CounterMonitorMBean
value - The offset value.IllegalArgumentException - The specified offset is null or the offset value is less than zero.getOffset()public Number getModulus()
Gets the modulus value common to all observed MBeans.
getModulus in interface CounterMonitorMBean
setModulus(java.lang.Number)public void setModulus(Number value)
throws IllegalArgumentException Sets the modulus value common to all observed MBeans.
setModulus in interface CounterMonitorMBean
value - The modulus value.IllegalArgumentException - The specified modulus is null or the modulus value is less than zero.getModulus()public boolean getNotify()
Gets the notification's on/off switch value common to all observed MBeans.
getNotify in interface CounterMonitorMBean
true if the counter monitor notifies when exceeding the threshold, false otherwise.setNotify(boolean)public void setNotify(boolean value)
Sets the notification's on/off switch value common to all observed MBeans.
setNotify in interface CounterMonitorMBean
value - The notification's on/off switch value.getNotify()public boolean getDifferenceMode()
Gets the difference mode flag value common to all observed MBeans.
getDifferenceMode in interface CounterMonitorMBean
true if the difference mode is used, false otherwise.setDifferenceMode(boolean)public void setDifferenceMode(boolean value)
Sets the difference mode flag value common to all observed MBeans.
setDifferenceMode in interface CounterMonitorMBean
value - The difference mode flag value.getDifferenceMode()public MBeanNotificationInfo[] getNotificationInfo()
Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by the counter monitor.
getNotificationInfo in interface NotificationBroadcaster
getNotificationInfo in class NotificationBroadcasterSupport
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.