| Methods Summary |
|---|
| public synchronized java.lang.Number | getDerivedGauge()Returns the derived gauge of the first object in the set of
observed MBeans.
return derivedGauge[0];
|
| public synchronized java.lang.Number | getDerivedGauge(javax.management.ObjectName object)Gets the derived gauge of the specified object, if this object is
contained in the set of observed MBeans, or null otherwise.
int index = indexOf(object);
if (index != -1)
return derivedGauge[index];
else
return null;
|
| public synchronized long | getDerivedGaugeTimeStamp()Gets the derived gauge timestamp of the first object in the set
of observed MBeans.
return derivedGaugeTimestamp[0];
|
| public synchronized long | getDerivedGaugeTimeStamp(javax.management.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.
int index = indexOf(object);
if (index != -1)
return derivedGaugeTimestamp[index];
else
return 0;
|
| public synchronized boolean | getDifferenceMode()Gets the difference mode flag value common to all observed MBeans.
return differenceMode;
|
| public synchronized java.lang.Number | getInitThreshold()Gets the initial threshold value common to all observed objects.
return initThreshold;
|
| public synchronized java.lang.Number | getModulus()Gets the modulus value common to all observed MBeans.
return modulus;
|
| public javax.management.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.
String[] types = { MonitorNotification.RUNTIME_ERROR,
MonitorNotification.OBSERVED_OBJECT_ERROR,
MonitorNotification.OBSERVED_ATTRIBUTE_ERROR,
MonitorNotification.OBSERVED_ATTRIBUTE_TYPE_ERROR,
MonitorNotification.THRESHOLD_ERROR,
MonitorNotification.THRESHOLD_VALUE_EXCEEDED};
MBeanNotificationInfo[] notifsInfo = {
new MBeanNotificationInfo(types,
"javax.management.monitor.MonitorNotification",
"Notifications sent by the CounterMonitor MBean")
};
return notifsInfo;
|
| public synchronized boolean | getNotify()Gets the notification's on/off switch value common to all
observed MBeans.
return notify;
|
| public synchronized java.lang.Number | getOffset()Gets the offset value common to all observed MBeans.
return offset;
|
| public synchronized java.lang.Number | getThreshold()Gets the threshold value of the first object in the set of
observed MBeans.
return threshold[0];
|
| public synchronized java.lang.Number | getThreshold(javax.management.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.
int index = indexOf(object);
if (index != -1)
return threshold[index];
else
return null;
|
| synchronized void | insertSpecificElementAt(int index)This method is called when adding a new observed object in the vector.
It updates all the counter specific arrays.
// Update threshold, derivedGauge, derivedGaugeTimestamp,
// previousScanCounter, modulusExceeded, derivedGaugeExceeded,
// eventAlreadyNotified and type values.
if (index != elementCount)
throw new Error("Internal error: index != elementCount");
if (elementCount >= threshold.length) {
threshold = expandArray(threshold);
derivedGauge = expandArray(derivedGauge);
previousScanCounter = expandArray(previousScanCounter);
derivedGaugeExceeded = expandArray(derivedGaugeExceeded);
derivedGaugeTimestamp = expandArray(derivedGaugeTimestamp);
modulusExceeded = expandArray(modulusExceeded);
eventAlreadyNotified = expandArray(eventAlreadyNotified);
type = expandArray(type);
}
threshold[index] = INTEGER_ZERO;
derivedGauge[index] = INTEGER_ZERO;
previousScanCounter[index] = null;
derivedGaugeExceeded[index] = null;
derivedGaugeTimestamp[index] = System.currentTimeMillis();
modulusExceeded[index] = false;
eventAlreadyNotified[index] = false;
type[index] = INTEGER;
|
| private synchronized boolean | isThresholdTypeValid(int index)Tests if the threshold, offset and modulus of the specified index are
of the same type as the counter. Only integer types are allowed.
Note:
If the optional offset or modulus have not been initialized, their
default value is an Integer object with a value equal to zero.
switch(type[index]) {
case INTEGER:
return ((threshold[index] instanceof Integer) &&
((offset == INTEGER_ZERO) ||
(offset instanceof Integer)) &&
((modulus == INTEGER_ZERO) ||
(modulus instanceof Integer)));
case BYTE:
return ((threshold[index] instanceof Byte) &&
((offset == INTEGER_ZERO) ||
(offset instanceof Byte)) &&
((modulus == INTEGER_ZERO) ||
(modulus instanceof Byte)));
case SHORT:
return ((threshold[index] instanceof Short) &&
((offset == INTEGER_ZERO) ||
(offset instanceof Short)) &&
((modulus == INTEGER_ZERO) ||
(modulus instanceof Short)));
case LONG:
return ((threshold[index] instanceof Long) &&
((offset == INTEGER_ZERO) ||
(offset instanceof Long)) &&
((modulus == INTEGER_ZERO) ||
(modulus instanceof Long)));
default:
// Should never occured...
if (isDebugOn()) {
debug("isThresholdTypeValid", "The threshold type is invalid");
}
return false;
}
|
| java.lang.String | makeDebugTag()
// TRACES & DEBUG
//---------------
return "CounterMonitor";
|
| void | notifyAlarmClock(int index)This method is called by the counter monitor each time
the granularity period has been exceeded.
long timeStamp = 0;
String msg = null;
Object derGauge = null;
Object scan_counter = null;
String notif_type = null;
synchronized(this) {
if (!isActive())
return;
// Check if the observed object and observed attribute are valid.
//
// Check that neither the observed object nor the
// observed attribute are null. If the observed
// object or observed attribute is null, this means
// that the monitor started before a complete
// initialization and nothing is done.
//
if ((getObservedObject(index) == null) ||
(getObservedAttribute() == null)) {
return;
}
// Check that the observed object is registered in the
// MBean server and that the observed attribute
// belongs to the observed object.
//
try {
scan_counter = server.getAttribute(getObservedObject(index),
getObservedAttribute());
if (scan_counter == null)
return;
} catch (NullPointerException np_ex) {
if (alreadyNotified(index, RUNTIME_ERROR_NOTIFIED))
return;
else {
notif_type = MonitorNotification.RUNTIME_ERROR;
setAlreadyNotified(index, RUNTIME_ERROR_NOTIFIED);
msg =
"The counter monitor must be registered in " +
"the MBean server.";
}
} catch (InstanceNotFoundException inf_ex) {
if (alreadyNotified(index, OBSERVED_OBJECT_ERROR_NOTIFIED))
return;
else {
notif_type = MonitorNotification.OBSERVED_OBJECT_ERROR;
setAlreadyNotified(index, OBSERVED_OBJECT_ERROR_NOTIFIED);
msg =
"The observed object must be registered in " +
"the MBean server.";
}
} catch (AttributeNotFoundException anf_ex) {
if (alreadyNotified(index, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED))
return;
else {
notif_type = MonitorNotification.OBSERVED_ATTRIBUTE_ERROR;
setAlreadyNotified(index, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED);
msg =
"The observed attribute must be accessible in " +
"the observed object.";
}
} catch (MBeanException mb_ex) {
if (alreadyNotified(index, RUNTIME_ERROR_NOTIFIED))
return;
else {
notif_type = MonitorNotification.RUNTIME_ERROR;
setAlreadyNotified(index, RUNTIME_ERROR_NOTIFIED);
msg = mb_ex.getMessage();
}
} catch (ReflectionException ref_ex) {
if (alreadyNotified(index, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED)) {
return;
} else {
notif_type = MonitorNotification.OBSERVED_ATTRIBUTE_ERROR;
setAlreadyNotified(index, OBSERVED_ATTRIBUTE_ERROR_NOTIFIED);
msg = ref_ex.getMessage();
}
}
if (msg == null) {
// Check that the observed attribute is of type "Integer".
//
if (scan_counter instanceof Integer) {
type[index] = INTEGER;
} else if (scan_counter instanceof Byte) {
type[index] = BYTE;
} else if (scan_counter instanceof Short) {
type[index] = SHORT;
} else if (scan_counter instanceof Long) {
type[index] = LONG;
} else {
if (alreadyNotified(index,
OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED))
return;
else {
notif_type =
MonitorNotification.OBSERVED_ATTRIBUTE_TYPE_ERROR;
setAlreadyNotified(index,
OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED);
msg =
"The observed attribute type must be " +
"an integer type.";
}
}
}
if (msg == null) {
// Check that threshold, offset and modulus have
// values that fit in the counter's type
//
if (!isThresholdTypeValid(index)) {
if (alreadyNotified(index, THRESHOLD_ERROR_NOTIFIED))
return;
else {
notif_type = MonitorNotification.THRESHOLD_ERROR;
setAlreadyNotified(index, THRESHOLD_ERROR_NOTIFIED);
msg =
"The threshold, offset and modulus must " +
"be of the same type as the counter.";
}
}
}
if (msg == null) {
// Clear all already notified flags.
//
resetAllAlreadyNotified(index);
// Check if counter has wrapped around.
//
if (modulusExceeded[index]) {
if (derivedGauge[index].longValue() <
derivedGaugeExceeded[index].longValue()) {
threshold[index] = initThreshold;
modulusExceeded[index] = false;
eventAlreadyNotified[index] = false;
}
}
// Update the derived gauge attributes and check the
// validity of the new value. The derived gauge value
// is invalid when the differenceMode flag is set to
// true and it is the first notification (so we
// haven't 2 consecutive values to update the derived
// gauge).
//
boolean is_derived_gauge_valid =
updateDerivedGauge(scan_counter, index);
// Notify the listeners and update the threshold if
// the updated derived gauge value is valid.
//
if (is_derived_gauge_valid) {
updateNotifications(index);
updateThreshold(index);
}
} else {
// msg != null, will send an error notification
timeStamp = derivedGaugeTimestamp[index];
derGauge = derivedGauge[index];
// Reset values.
//
modulusExceeded[index] = false;
eventAlreadyNotified[index] = false;
previousScanCounter[index] = null;
}
}
if (msg != null) {
sendNotification(notif_type,
timeStamp,
msg,
derGauge,
null,
index);
}
|
| public void | preDeregister()Allows the counter monitor MBean to perform any operations it
needs before being unregistered by the MBean server.
Resets the threshold values.
// Stop the CounterMonitor.
//
super.preDeregister();
if (isTraceOn()) {
trace("preDeregister", "reset the threshold values");
}
// Reset values for serialization.
//
synchronized (this) {
for (int i = 0; i < elementCount; i++) {
threshold[i] = initThreshold;
}
}
|
| synchronized void | removeSpecificElementAt(int index)This method is called when removing an observed object from the vector.
It updates all the counter specific arrays.
// Update threshold, derivedGauge, derivedGaugeTimestamp,
// previousScanCounter, modulusExceeded, derivedGaugeExceeded,
// eventAlreadyNotified and type values.
//
removeElementAt(threshold, index);
removeElementAt(derivedGauge, index);
removeElementAt(previousScanCounter, index);
removeElementAt(derivedGaugeExceeded, index);
removeElementAt(derivedGaugeTimestamp, index);
removeElementAt(modulusExceeded, index);
removeElementAt(eventAlreadyNotified, index);
removeElementAt(type, index);
|
| private synchronized void | setDerivedGaugeWithDifference(java.lang.Number scanCounter, java.lang.Number mod, int index)Sets the derived gauge of the specified index when the
differenceMode flag is set to true. Integer types
only are allowed.
/* We do the arithmetic using longs here even though the
result may end up in a smaller type. Since
l == (byte)l (mod 256) for any long l,
(byte) ((byte)l1 + (byte)l2) == (byte) (l1 + l2),
and likewise for subtraction. So it's the same as if
we had done the arithmetic in the smaller type.*/
long derived =
scanCounter.longValue() - previousScanCounter[index].longValue();
if (mod != null)
derived += modulus.longValue();
switch (type[index]) {
case INTEGER: derivedGauge[index] = new Integer((int) derived); break;
case BYTE: derivedGauge[index] = new Byte((byte) derived); break;
case SHORT: derivedGauge[index] = new Short((short) derived); break;
case LONG: derivedGauge[index] = new Long(derived); break;
default:
// Should never occur...
if (isDebugOn()) {
debug("setDerivedGaugeWithDifference",
"the threshold type is invalid");
}
break;
}
|
| public synchronized void | setDifferenceMode(boolean value)Sets the difference mode flag value common to all observed MBeans.
differenceMode = value;
for (int i = 0; i < elementCount; i++) {
// Reset values.
//
threshold[i] = initThreshold;
modulusExceeded[i] = false;
eventAlreadyNotified[i] = false;
previousScanCounter[i] = null;
}
|
| public synchronized void | setGranularityPeriod(long period)Sets the granularity period (in milliseconds).
The default value of the granularity period is 10 seconds.
super.setGranularityPeriod(period);
// Reschedule timer task if timer is already running
//
if (isActive()) {
timer.cancel();
timer = new Timer();
timer.schedule(new CounterAlarmClock(this),
getGranularityPeriod(), getGranularityPeriod());
}
|
| public synchronized void | setInitThreshold(java.lang.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.
if (value == null) {
throw new IllegalArgumentException("Null threshold");
}
if (value.longValue() < 0L) {
throw new IllegalArgumentException("Negative threshold");
}
initThreshold = value;
for (int i = 0; i < elementCount; i++) {
threshold[i] = value;
resetAlreadyNotified(i, THRESHOLD_ERROR_NOTIFIED);
// Reset values.
//
modulusExceeded[i] = false;
eventAlreadyNotified[i] = false;
}
|
| public synchronized void | setModulus(java.lang.Number value)Sets the modulus value common to all observed MBeans.
if (value == null) {
throw new IllegalArgumentException("Null modulus");
}
if (value.longValue() < 0L) {
throw new IllegalArgumentException("Negative modulus");
}
modulus = value;
for (int i = 0; i < elementCount; i++) {
resetAlreadyNotified(i, THRESHOLD_ERROR_NOTIFIED);
// Reset values.
//
modulusExceeded[i] = false;
}
|
| public synchronized void | setNotify(boolean value)Sets the notification's on/off switch value common to all
observed MBeans.
notify = value;
|
| public synchronized void | setOffset(java.lang.Number value)Sets the offset value common to all observed MBeans.
if (value == null) {
throw new IllegalArgumentException("Null offset");
}
if (value.longValue() < 0L) {
throw new IllegalArgumentException("Negative offset");
}
offset = value;
for (int i = 0; i < elementCount; i++) {
resetAlreadyNotified(i, THRESHOLD_ERROR_NOTIFIED);
}
|
| public synchronized void | setThreshold(java.lang.Number value)Sets the initial threshold value.
setInitThreshold(value);
|
| public synchronized void | start()Starts the counter monitor.
if (isTraceOn()) {
trace("start", "start the counter monitor");
}
if (isActive()) {
if (isTraceOn()) {
trace("start", "the counter monitor is already activated");
}
return;
}
isActive = true;
// Reset values.
//
for (int i = 0; i < elementCount; i++) {
threshold[i] = initThreshold;
modulusExceeded[i] = false;
eventAlreadyNotified[i] = false;
previousScanCounter[i] = null;
}
// Start the timer.
//
timer = new Timer();
timer.schedule(new CounterAlarmClock(this), getGranularityPeriod(),
getGranularityPeriod());
|
| public synchronized void | stop()Stops the counter monitor.
This method is not synchronized, because if it were there could
be a deadlock with a thread that attempted to get the lock on
the monitor before being interrupted or noticing that it had
been interrupted.
if (isTraceOn()) {
trace("stop", "stop the counter monitor");
}
if (isTraceOn()) {
trace("stop", "the counter monitor is not started");
return;
}
isActive = false;
// Stop the timer.
//
if (timer != null) {
timer.cancel();
timer = null;
}
|
| private synchronized boolean | updateDerivedGauge(java.lang.Object scanCounter, int index)Updates the derived gauge and the derived gauge timestamp attributes
of the observed object at the specified index.
boolean is_derived_gauge_valid;
derivedGaugeTimestamp[index] = System.currentTimeMillis();
// The counter difference mode is used.
//
if (differenceMode) {
// The previous scan counter has been initialized.
//
if (previousScanCounter[index] != null) {
setDerivedGaugeWithDifference((Number)scanCounter, null, index);
// If derived gauge is negative it means that the
// counter has wrapped around and the value of the
// threshold needs to be reset to its initial value.
//
if (derivedGauge[index].longValue() < 0L) {
if (modulus.longValue() > 0L) {
setDerivedGaugeWithDifference((Number)scanCounter,
(Number)modulus, index);
}
threshold[index] = initThreshold;
eventAlreadyNotified[index] = false;
}
is_derived_gauge_valid = true;
}
// The previous scan counter has not been initialized.
// We cannot update the derived gauge...
//
else {
is_derived_gauge_valid = false;
}
previousScanCounter[index] = (Number)scanCounter;
}
// The counter difference mode is not used.
//
else {
derivedGauge[index] = (Number)scanCounter;
is_derived_gauge_valid = true;
}
return is_derived_gauge_valid;
|
| private void | updateNotifications(int index)Updates the notification attribute of the observed object at the
specified index and notifies the listeners only once if the notify flag
is set to true.
boolean sendNotif = false;
String notifType = null;
long timeStamp = 0;
String msg = null;
Object derGauge = null;
Object trigger = null;
synchronized(this) {
// Send notification if notify is true.
//
if (!eventAlreadyNotified[index]) {
if (derivedGauge[index].longValue() >=
threshold[index].longValue()) {
if (notify) {
sendNotif = true;
notifType = MonitorNotification.THRESHOLD_VALUE_EXCEEDED;
timeStamp = derivedGaugeTimestamp[index];
msg = "";
derGauge = derivedGauge[index];
trigger = threshold[index];
}
if (!differenceMode) {
eventAlreadyNotified[index] = true;
}
}
} else {
if (isTraceOn()) {
trace("updateNotifications", "the notification:" +
"\n\tNotification observed object = " +
getObservedObject(index) +
"\n\tNotification observed attribute = " +
getObservedAttribute() +
"\n\tNotification derived gauge = " +
derivedGauge[index] +
"\nhas already been sent");
}
}
}
if (sendNotif) {
sendNotification(notifType, timeStamp, msg, derGauge, trigger, index);
}
|
| private synchronized void | updateThreshold(int index)Updates the threshold attribute of the observed object at the
specified index.
// Calculate the new threshold value if the threshold has been
// exceeded and if the offset value is greater than zero.
//
if (derivedGauge[index].longValue() >= threshold[index].longValue()) {
if (offset.longValue() > 0L) {
// Increment the threshold until its value is greater
// than the one for the current derived gauge.
//
long threshold_value = threshold[index].longValue();
while (derivedGauge[index].longValue() >= threshold_value) {
threshold_value += offset.longValue();
}
// Set threshold attribute.
//
switch(type[index]) {
case INTEGER:
threshold[index] = new Integer((int)threshold_value);
break;
case BYTE:
threshold[index] = new Byte((byte)threshold_value);
break;
case SHORT:
threshold[index] = new Short((short)threshold_value);
break;
case LONG:
threshold[index] = new Long((long)threshold_value);
break;
default:
// Should never occur...
if (isDebugOn()) {
debug("updateThreshold", "the threshold type is invalid");
}
break;
}
// If the counter can wrap around when it reaches its maximum
// and we are not dealing with counter differences then we need
// to reset the threshold to its initial value too.
//
if (!differenceMode) {
if (modulus.longValue() > 0L) {
if (threshold[index].longValue() > modulus.longValue()) {
modulusExceeded[index] = true;
derivedGaugeExceeded[index] = derivedGauge[index];
}
}
}
// Threshold value has been modified so we can notify again.
//
eventAlreadyNotified[index] = false;
}
else {
modulusExceeded[index] = true;
derivedGaugeExceeded[index] = derivedGauge[index];
}
}
|
