|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | 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:
Byte
, Integer
, Short
, Long
).
Fields inherited from class javax.management.monitor.Monitor |
alreadyNotified,
dbgTag,
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 | |
java.lang.Number |
getDerivedGauge()
Gets the derived gauge. |
long |
getDerivedGaugeTimeStamp()
Gets the derived gauge timestamp. |
boolean |
getDifferenceMode()
Gets the difference mode flag value. |
java.lang.Number |
getModulus()
Gets the modulus value. |
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. |
java.lang.Number |
getOffset()
Gets the offset value. |
java.lang.Number |
getThreshold()
Gets the threshold value. |
void |
preDeregister()
Allows the counter monitor MBean to perform any operations it needs before being de-registered by the MBean server. |
void |
setDifferenceMode(boolean value)
Sets the difference mode flag value. |
void |
setModulus(java.lang.Number value)
Sets the modulus value. |
void |
setNotify(boolean value)
Sets the notification's on/off switch value. |
void |
setOffset(java.lang.Number value)
Sets the offset value. |
void |
setThreshold(java.lang.Number value)
Sets the threshold value. |
void |
start()
Starts the counter monitor. |
void |
stop()
Stops the counter monitor. |
Methods inherited from class javax.management.monitor.Monitor |
getGranularityPeriod,
getObservedAttribute,
getObservedObject,
isActive,
postDeregister,
postRegister,
preRegister,
setGranularityPeriod,
setObservedAttribute,
setObservedObject |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener,
removeNotificationListener,
sendNotification |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public CounterMonitor()
Method Detail |
public void preDeregister() throws java.lang.Exception
Resets the threshold values.
public void start()
public void stop()
public java.lang.Number getDerivedGauge()
public long getDerivedGaugeTimeStamp()
public java.lang.Number getThreshold()
public void setThreshold(java.lang.Number value) throws java.lang.IllegalArgumentException
value
- The threshold value.public java.lang.Number getOffset()
public void setOffset(java.lang.Number value) throws java.lang.IllegalArgumentException
value
- The offset value.public java.lang.Number getModulus()
public void setModulus(java.lang.Number value) throws java.lang.IllegalArgumentException
value
- The modulus value.public boolean getNotify()
true
if the counter monitor notifies when exceeding the threshold, false
otherwise.public void setNotify(boolean value)
value
- The notification's on/off switch value.public boolean getDifferenceMode()
true
if the difference mode is used, false
otherwise.public void setDifferenceMode(boolean value)
value
- The difference mode flag value.public MBeanNotificationInfo[] getNotificationInfo()
NotificationInfo
object containing the name of the Java class of the notification
and the notification types sent by the counter monitor.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |