public class

CounterMonitor

extends Monitor
implements CounterMonitorMBean

java.lang.Object
↳	javax.management.NotificationBroadcasterSupport
	↳	javax.management.monitor.Monitor
		↳	javax.management.monitor.CounterMonitor

Class Overview

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:

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

This implementation of the counter monitor requires the observed attribute to be of the type integer (Byte, Integer, Short, Long).

Summary

[Expand]

Inherited Constants

From class javax.management.monitor.Monitor

[Expand]

Inherited Fields

From class javax.management.monitor.Monitor

Public Constructors
	CounterMonitor() Default constructor.

Public Methods
synchronized Number	getDerivedGauge() This method is deprecated. As of JMX 1.2, replaced by `getDerivedGauge(ObjectName)`
synchronized 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.
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, or `0` otherwise.
synchronized long	getDerivedGaugeTimeStamp() This method is deprecated. As of JMX 1.2, replaced by `getDerivedGaugeTimeStamp(ObjectName)`
synchronized boolean	getDifferenceMode() Gets the difference mode flag value common to all observed MBeans.
synchronized Number	getInitThreshold() Gets the initial threshold value common to all observed objects.
synchronized Number	getModulus() Gets the modulus value common to all observed MBeans.
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.
synchronized boolean	getNotify() Gets the notification's on/off switch value common to all observed MBeans.
synchronized Number	getOffset() Gets the offset value common to all observed MBeans.
synchronized Number	getThreshold() This method is deprecated. As of JMX 1.2, replaced by `getThreshold(ObjectName)`
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, or `null` otherwise.
synchronized void	setDifferenceMode(boolean value) Sets the difference mode flag value common to all observed MBeans.
synchronized void	setInitThreshold(Number value) Sets the initial threshold value common to all observed objects.
synchronized void	setModulus(Number value) Sets the modulus value common to all observed MBeans.
synchronized void	setNotify(boolean value) Sets the notification's on/off switch value common to all observed MBeans.
synchronized void	setOffset(Number value) Sets the offset value common to all observed MBeans.
synchronized void	setThreshold(Number value) This method is deprecated. As of JMX 1.2, replaced by `setInitThreshold(Number)`
synchronized void	start() Starts the counter monitor.
synchronized void	stop() Stops the counter monitor.

[Expand]

Inherited Methods

From class javax.management.monitor.Monitor

synchronized void	addObservedObject(ObjectName object) Adds the specified object in the set of observed MBeans, if this object is not already present.
synchronized boolean	containsObservedObject(ObjectName object) Tests whether the specified object is in the set of observed MBeans.
synchronized long	getGranularityPeriod() Gets the granularity period (in milliseconds).
synchronized String	getObservedAttribute() Gets the attribute being observed.
synchronized ObjectName	getObservedObject() This method is deprecated. As of JMX 1.2, replaced by `getObservedObjects()`
synchronized ObjectName[]	getObservedObjects() Returns an array containing the objects being observed.
synchronized boolean	isActive() Tests whether the monitor MBean is active.
void	postDeregister() Allows the monitor MBean to perform any operations needed after having been unregistered by the MBean server.
void	postRegister(Boolean registrationDone) Allows the monitor MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
void	preDeregister() Allows the monitor MBean to perform any operations it needs before being unregistered by the MBean server.
ObjectName	preRegister(MBeanServer server, ObjectName name) Allows the monitor MBean to perform any operations it needs before being registered in the MBean server.
synchronized void	removeObservedObject(ObjectName object) Removes the specified object from the set of observed MBeans.
synchronized void	setGranularityPeriod(long period) Sets the granularity period (in milliseconds).
void	setObservedAttribute(String attribute) Sets the attribute to observe.
synchronized void	setObservedObject(ObjectName object) This method is deprecated. As of JMX 1.2, replaced by `addObservedObject(ObjectName)`
abstract void	start() Starts the monitor.
abstract void	stop() Stops the monitor.

From class javax.management.NotificationBroadcasterSupport

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.management.MBeanRegistration

From interface javax.management.NotificationBroadcaster

From interface javax.management.NotificationEmitter

From interface javax.management.monitor.CounterMonitorMBean

From interface javax.management.monitor.MonitorMBean

Public Constructors

public CounterMonitor ()

Default constructor.

Public Methods

public synchronized Number getDerivedGauge ()

This method is deprecated.
As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Returns the derived gauge of the first object in the set of observed MBeans.

Returns

The derived gauge.

public synchronized 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.

Parameters

object	the name of the object whose derived gauge is to be returned.

Returns

The derived gauge of the specified object.

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, or 0 otherwise.

Parameters

object	the name of the object whose derived gauge timestamp is to be returned.

Returns

The derived gauge timestamp of the specified object.

public synchronized long getDerivedGaugeTimeStamp ()

This method is 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.

Returns

The derived gauge timestamp.

public synchronized boolean getDifferenceMode ()

Gets the difference mode flag value common to all observed MBeans.

Returns

true if the difference mode is used, false otherwise.

public synchronized Number getInitThreshold ()

Gets the initial threshold value common to all observed objects.

Returns

The initial threshold.

public synchronized Number getModulus ()

Gets the modulus value common to all observed MBeans.

Returns

The modulus value.

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.

Returns

the array of possible notifications.

public synchronized boolean getNotify ()

Gets the notification's on/off switch value common to all observed MBeans.

Returns

true if the counter monitor notifies when exceeding the threshold, false otherwise.

public synchronized Number getOffset ()

Gets the offset value common to all observed MBeans.

Returns

The offset value.

public synchronized Number getThreshold ()

This method is deprecated.
As of JMX 1.2, replaced by getThreshold(ObjectName)

Gets the threshold value of the first object in the set of observed MBeans.

Returns

The threshold value.

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, or null otherwise.

Parameters

object	the name of the object whose threshold is to be returned.

Returns

The threshold value of the specified object.

public synchronized void setDifferenceMode (boolean value)

Sets the difference mode flag value common to all observed MBeans.

Parameters

value	The difference mode flag value.

public synchronized void setInitThreshold (Number value)

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.

Parameters

value	The initial threshold value.

Throws

IllegalArgumentException	The specified threshold is null or the threshold value is less than zero.

public synchronized void setModulus (Number value)

Sets the modulus value common to all observed MBeans.

Parameters

value	The modulus value.

Throws

IllegalArgumentException	The specified modulus is null or the modulus value is less than zero.

public synchronized void setNotify (boolean value)

Sets the notification's on/off switch value common to all observed MBeans.

Parameters

value	The notification's on/off switch value.

public synchronized void setOffset (Number value)

Sets the offset value common to all observed MBeans.

Parameters

value	The offset value.

Throws

IllegalArgumentException	The specified offset is null or the offset value is less than zero.

public synchronized void setThreshold (Number value)

This method is deprecated.
As of JMX 1.2, replaced by setInitThreshold(Number)

Sets the initial threshold value.

Parameters

value	The initial threshold value.

Throws

IllegalArgumentException	The specified threshold is null or the threshold value is less than zero.

public synchronized void start ()

Starts the counter monitor.

public synchronized void stop ()

Stops the counter monitor.

Interfaces

Classes

Exceptions

CounterMonitor

Class Overview

Summary

Public Constructors

public CounterMonitor ()

Public Methods

public synchronized Number getDerivedGauge ()

Returns

public synchronized Number getDerivedGauge (ObjectName object)

Parameters

Returns

public synchronized long getDerivedGaugeTimeStamp (ObjectName object)

Parameters

Returns

public synchronized long getDerivedGaugeTimeStamp ()

Returns

public synchronized boolean getDifferenceMode ()

Returns

See Also

public synchronized Number getInitThreshold ()

Returns

See Also

public synchronized Number getModulus ()

Returns

See Also

public MBeanNotificationInfo[] getNotificationInfo ()

Returns

public synchronized boolean getNotify ()

Returns

See Also

public synchronized Number getOffset ()

Returns

See Also

public synchronized Number getThreshold ()

Returns

See Also

public synchronized Number getThreshold (ObjectName object)

Parameters

Returns

public synchronized void setDifferenceMode (boolean value)

Parameters

See Also

public synchronized void setInitThreshold (Number value)

Parameters

Throws

See Also

public synchronized void setModulus (Number value)

Parameters

Throws

See Also

public synchronized void setNotify (boolean value)

Parameters

See Also

public synchronized void setOffset (Number value)

Parameters

Throws

See Also

public synchronized void setThreshold (Number value)

Parameters

Throws

See Also

public synchronized void start ()

public synchronized void stop ()