|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.management.NotificationBroadcasterSupport javax.management.monitor.Monitor javax.management.monitor.CounterMonitor
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:
w *
Byte
, Integer
, Short
, Long
).
Field Summary |
Fields inherited from class javax.management.monitor.Monitor |
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 |
Constructor Summary | |
CounterMonitor()
Default constructor. |
Method Summary | |
Number |
getDerivedGauge()
Deprecated. As of JMX 1.2, replaced by getDerivedGauge(ObjectName) |
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. |
long |
getDerivedGaugeTimeStamp()
Deprecated. As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName) |
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 null otherwise. |
boolean |
getDifferenceMode()
Gets the difference mode flag value common to all observed MBeans. |
Number |
getInitThreshold()
Gets the initial threshold value common to all observed objects. |
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. |
boolean |
getNotify()
Gets the notification's on/off switch value common to all observed MBeans. |
Number |
getOffset()
Gets the offset value common to all observed MBeans. |
Number |
getThreshold()
Deprecated. As of JMX 1.2, replaced by getThreshold(ObjectName) |
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. |
void |
preDeregister()
Allows the counter monitor MBean to perform any operations it needs before being unregistered by the MBean server. |
void |
setDifferenceMode(boolean value)
Sets the difference mode flag value common to all observed MBeans. |
void |
setGranularityPeriod(long period)
Sets the granularity period (in milliseconds). |
void |
setInitThreshold(Number value)
Sets the initial threshold value common to all observed objects. |
void |
setModulus(Number value)
Sets the modulus value common to all observed MBeans. |
void |
setNotify(boolean value)
Sets the notification's on/off switch value common to all observed MBeans. |
void |
setOffset(Number value)
Sets the offset value common to all observed MBeans. |
void |
setThreshold(Number value)
Deprecated. As of JMX 1.2, replaced by setInitThreshold(java.lang.Number) |
void |
start()
Starts the counter monitor. |
void |
stop()
Stops the counter monitor. |
Methods inherited from class javax.management.monitor.Monitor |
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, postDeregister, postRegister, preRegister, removeObservedObject, setObservedAttribute, setObservedObject |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.management.monitor.MonitorMBean |
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setObservedAttribute, setObservedObject |
Constructor Detail |
public CounterMonitor()
Method Detail |
public void preDeregister() throws Exception
Resets the threshold values.
preDeregister
in interface MBeanRegistration
preDeregister
in class Monitor
Exception
public void start()
start
in interface MonitorMBean
start
in class Monitor
public void stop()
stop
in interface MonitorMBean
stop
in class Monitor
public void setGranularityPeriod(long period) throws IllegalArgumentException
setGranularityPeriod
in interface MonitorMBean
setGranularityPeriod
in class Monitor
period
- The granularity period value.
IllegalArgumentException
- The granularity
period is less than or equal to zero.Monitor.setGranularityPeriod(long)
public Number getDerivedGauge(ObjectName object)
null
otherwise.
getDerivedGauge
in interface CounterMonitorMBean
object
- the name of the object whose derived gauge is to
be returned.
public long getDerivedGaugeTimeStamp(ObjectName object)
null
otherwise.
getDerivedGaugeTimeStamp
in interface CounterMonitorMBean
object
- the name of the object whose derived gauge
timestamp is to be returned.
public Number getThreshold(ObjectName object)
null
otherwise.
getThreshold
in interface CounterMonitorMBean
object
- the name of the object whose threshold is to be
returned.
setThreshold(java.lang.Number)
public Number getInitThreshold()
getInitThreshold
in interface CounterMonitorMBean
setInitThreshold(java.lang.Number)
public void setInitThreshold(Number value) throws IllegalArgumentException
setInitThreshold
in interface CounterMonitorMBean
value
- The initial threshold value.
IllegalArgumentException
- The specified threshold is null or the threshold value is less than zero.getInitThreshold()
public Number getDerivedGauge()
getDerivedGauge(ObjectName)
getDerivedGauge
in interface CounterMonitorMBean
public long getDerivedGaugeTimeStamp()
getDerivedGaugeTimeStamp(ObjectName)
getDerivedGaugeTimeStamp
in interface CounterMonitorMBean
public Number getThreshold()
getThreshold(ObjectName)
getThreshold
in interface CounterMonitorMBean
setThreshold(Number)
public void setThreshold(Number value) throws IllegalArgumentException
setInitThreshold(java.lang.Number)
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()
getOffset
in interface CounterMonitorMBean
setOffset(java.lang.Number)
public void setOffset(Number value) throws IllegalArgumentException
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()
getModulus
in interface CounterMonitorMBean
setModulus(java.lang.Number)
public void setModulus(Number value) throws IllegalArgumentException
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()
getNotify
in interface CounterMonitorMBean
true
if the counter monitor notifies when
exceeding the threshold, false
otherwise.setNotify(boolean)
public void setNotify(boolean value)
setNotify
in interface CounterMonitorMBean
value
- The notification's on/off switch value.getNotify()
public boolean getDifferenceMode()
getDifferenceMode
in interface CounterMonitorMBean
true
if the difference mode is used,
false
otherwise.setDifferenceMode(boolean)
public void setDifferenceMode(boolean value)
setDifferenceMode
in interface CounterMonitorMBean
value
- The difference mode flag value.getDifferenceMode()
public MBeanNotificationInfo[] getNotificationInfo()
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
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.