1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
/* * @(#)StringMonitor.java 4.45 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.management.monitor; import javax.management.ObjectName; import javax.management.MBeanNotificationInfo; import static javax.management.monitor.MonitorNotification.*; /** * Defines a monitor MBean designed to observe the values of a string * attribute. * <P> * A string monitor sends notifications as follows: * <UL> * <LI> if the attribute value matches the string to compare value, * a {@link MonitorNotification#STRING_TO_COMPARE_VALUE_MATCHED * match notification} is sent. * The notify match flag must be set to <CODE>true</CODE>. * <BR>Subsequent matchings of the string to compare values do not * cause further notifications unless * the attribute value differs from the string to compare value. * <LI> if the attribute value differs from the string to compare value, * a {@link MonitorNotification#STRING_TO_COMPARE_VALUE_DIFFERED * differ notification} is sent. * The notify differ flag must be set to <CODE>true</CODE>. * <BR>Subsequent differences from the string to compare value do * not cause further notifications unless * the attribute value matches the string to compare value. * </UL> * * @version 4.45 11/17/05 * @author Sun Microsystems, Inc * * @since 1.5 */ public class StringMonitor extends Monitor implements StringMonitorMBean { // TRACES & DEBUG //--------------- String makeDebugTag() { return "StringMonitor"; } /* * ------------------------------------------ * PACKAGE CLASSES * ------------------------------------------ */ static class StringMonitorObservedObject extends ObservedObject { public StringMonitorObservedObject(ObjectName observedObject) { super(observedObject); } public final synchronized int getStatus() { return status; } public final synchronized void setStatus(int status) { this.status = status; } private int status; } /* * ------------------------------------------ * PRIVATE VARIABLES * ------------------------------------------ */ /** * String to compare with the observed attribute. * <BR>The default value is an empty character sequence. */ private String stringToCompare = ""; /** * Flag indicating if the string monitor notifies when matching * the string to compare. * <BR>The default value is set to <CODE>false</CODE>. */ private boolean notifyMatch = false; /** * Flag indicating if the string monitor notifies when differing * from the string to compare. * <BR>The default value is set to <CODE>false</CODE>. */ private boolean notifyDiffer = false; private static final String[] types = { RUNTIME_ERROR, OBSERVED_OBJECT_ERROR, OBSERVED_ATTRIBUTE_ERROR, OBSERVED_ATTRIBUTE_TYPE_ERROR, STRING_TO_COMPARE_VALUE_MATCHED, STRING_TO_COMPARE_VALUE_DIFFERED }; private static final MBeanNotificationInfo[] notifsInfo = { new MBeanNotificationInfo( types, "javax.management.monitor.MonitorNotification", "Notifications sent by the StringMonitor MBean") }; // Flags needed to implement the matching/differing mechanism. // private static final int MATCHING = 0; private static final int DIFFERING = 1; private static final int MATCHING_OR_DIFFERING = 2; /* * ------------------------------------------ * CONSTRUCTORS * ------------------------------------------ */ /** * Default constructor. */ public StringMonitor() { dbgTag = makeDebugTag(); } /* * ------------------------------------------ * PUBLIC METHODS * ------------------------------------------ */ /** * Starts the string monitor. */ public synchronized void start() { if (isActive()) { if (isTraceOn()) { trace("start", "the monitor is already active"); } return; } // Reset values. // for (ObservedObject o : observedObjects) { final StringMonitorObservedObject smo = (StringMonitorObservedObject) o; smo.setStatus(MATCHING_OR_DIFFERING); } doStart(); } /** * Stops the string monitor. */ public synchronized void stop() { doStop(); } // GETTERS AND SETTERS //-------------------- /** * Gets the derived gauge of the specified object, if this object is * contained in the set of observed MBeans, or <code>null</code> otherwise. * * @param object the name of the MBean whose derived gauge is required. * * @return The derived gauge of the specified object. * * @since.unbundled JMX 1.2 */ public synchronized String getDerivedGauge(ObjectName object) { return (String) super.getDerivedGauge(object); } /** * Gets the derived gauge timestamp of the specified object, if * this object is contained in the set of observed MBeans, or * <code>0</code> otherwise. * * @param object the name of the object whose derived gauge * timestamp is to be returned. * * @return The derived gauge timestamp of the specified object. * * @since.unbundled JMX 1.2 */ public synchronized long getDerivedGaugeTimeStamp(ObjectName object) { return super.getDerivedGaugeTimeStamp(object); } /** * Returns the derived gauge of the first object in the set of * observed MBeans. * * @return The derived gauge. * * @deprecated As of JMX 1.2, replaced by * {@link #getDerivedGauge(ObjectName)} */ @Deprecated public synchronized String getDerivedGauge() { if (observedObjects.isEmpty()) { return null; } else { return (String) observedObjects.get(0).getDerivedGauge(); } } /** * Gets the derived gauge timestamp of the first object in the set * of observed MBeans. * * @return The derived gauge timestamp. * * @deprecated As of JMX 1.2, replaced by * {@link #getDerivedGaugeTimeStamp(ObjectName)} */ @Deprecated public synchronized long getDerivedGaugeTimeStamp() { if (observedObjects.isEmpty()) { return 0; } else { return observedObjects.get(0).getDerivedGaugeTimeStamp(); } } /** * Gets the string to compare with the observed attribute common * to all observed MBeans. * * @return The string value. * * @see #setStringToCompare */ public synchronized String getStringToCompare() { return stringToCompare; } /** * Sets the string to compare with the observed attribute common * to all observed MBeans. * * @param value The string value. * * @exception IllegalArgumentException The specified * string to compare is null. * * @see #getStringToCompare */ public synchronized void setStringToCompare(String value) throws IllegalArgumentException { if (value == null) { throw new IllegalArgumentException("Null string to compare"); } if (stringToCompare.equals(value)) return; stringToCompare = value; // Reset values. // for (ObservedObject o : observedObjects) { final StringMonitorObservedObject smo = (StringMonitorObservedObject) o; smo.setStatus(MATCHING_OR_DIFFERING); } } /** * Gets the matching notification's on/off switch value common to * all observed MBeans. * * @return <CODE>true</CODE> if the string monitor notifies when * matching the string to compare, <CODE>false</CODE> otherwise. * * @see #setNotifyMatch */ public synchronized boolean getNotifyMatch() { return notifyMatch; } /** * Sets the matching notification's on/off switch value common to * all observed MBeans. * * @param value The matching notification's on/off switch value. * * @see #getNotifyMatch */ public synchronized void setNotifyMatch(boolean value) { if (notifyMatch == value) return; notifyMatch = value; } /** * Gets the differing notification's on/off switch value common to * all observed MBeans. * * @return <CODE>true</CODE> if the string monitor notifies when * differing from the string to compare, <CODE>false</CODE> otherwise. * * @see #setNotifyDiffer */ public synchronized boolean getNotifyDiffer() { return notifyDiffer; } /** * Sets the differing notification's on/off switch value common to * all observed MBeans. * * @param value The differing notification's on/off switch value. * * @see #getNotifyDiffer */ public synchronized void setNotifyDiffer(boolean value) { if (notifyDiffer == value) return; notifyDiffer = value; } /** * Returns a <CODE>NotificationInfo</CODE> object containing the name of * the Java class of the notification and the notification types sent by * the string monitor. */ public MBeanNotificationInfo[] getNotificationInfo() { return notifsInfo; } /* * ------------------------------------------ * PACKAGE METHODS * ------------------------------------------ */ /** * Factory method for ObservedObject creation. * * @since 1.6 */ @Override ObservedObject createObservedObject(ObjectName object) { final StringMonitorObservedObject smo = new StringMonitorObservedObject(object); smo.setStatus(MATCHING_OR_DIFFERING); return smo; } /** * Check that the type of the supplied observed attribute * value is one of the value types supported by this monitor. */ @Override synchronized boolean isComparableTypeValid(ObjectName object, String attribute, Comparable<?> value) { // Check that the observed attribute is of type "String". // if (value instanceof String) { return true; } return false; } @Override synchronized void onErrorNotification(MonitorNotification notification) { final StringMonitorObservedObject o = (StringMonitorObservedObject) getObservedObject(notification.getObservedObject()); if (o == null) return; // Reset values. // o.setStatus(MATCHING_OR_DIFFERING); } @Override synchronized MonitorNotification buildAlarmNotification( ObjectName object, String attribute, Comparable<?> value) { String type = null; String msg = null; Object trigger = null; final StringMonitorObservedObject o = (StringMonitorObservedObject) getObservedObject(object); if (o == null) return null; // Send matching notification if notifyMatch is true. // Send differing notification if notifyDiffer is true. // if (o.getStatus() == MATCHING_OR_DIFFERING) { if (o.getDerivedGauge().equals(stringToCompare)) { if (notifyMatch) { type = STRING_TO_COMPARE_VALUE_MATCHED; msg = ""; trigger = stringToCompare; } o.setStatus(DIFFERING); } else { if (notifyDiffer) { type = STRING_TO_COMPARE_VALUE_DIFFERED; msg = ""; trigger = stringToCompare; } o.setStatus(MATCHING); } } else { if (o.getStatus() == MATCHING) { if (o.getDerivedGauge().equals(stringToCompare)) { if (notifyMatch) { type = STRING_TO_COMPARE_VALUE_MATCHED; msg = ""; trigger = stringToCompare; } o.setStatus(DIFFERING); } } else if (o.getStatus() == DIFFERING) { if (!o.getDerivedGauge().equals(stringToCompare)) { if (notifyDiffer) { type = STRING_TO_COMPARE_VALUE_DIFFERED; msg = ""; trigger = stringToCompare; } o.setStatus(MATCHING); } } } return new MonitorNotification(type, this, 0, 0, msg, null, null, null, trigger); } }