001: /**
002: * The XMOJO Project 5
003: * Copyright © 2003 XMOJO.org. All rights reserved.
004:
005: * NO WARRANTY
006:
007: * BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
008: * THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
009: * OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
010: * PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
011: * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
012: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
013: * TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE
014: * LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
015: * REPAIR OR CORRECTION.
016:
017: * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
018: * ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
019: * THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
020: * GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
021: * USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF
022: * DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
023: * PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
024: * EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
025: * SUCH DAMAGES.
026: **/package javax.management;
027:
028: /**
029: * Provides definitions of the attribute change notifications sent by MBeans.
030: * <P>
031: * It's up to the MBean owning the attribute of interest to create and send
032: * attribute change notifications when the attribute change occurs.
033: * So the <CODE>NotificationBroadcaster</CODE> interface has to be implemented
034: * by any MBean for which an attribute change is of interest.
035: * <P>
036: * Example:
037: * If an MBean called <CODE>myMbean</CODE> needs to notify registered listeners
038: * when its attribute:
039: * <BLOCKQUOTE><CODE>
040: * String myString
041: * </CODE></BLOCKQUOTE>
042: * is modified, <CODE>myMbean</CODE> creates and emits the following notification:
043: * <BLOCKQUOTE><CODE>
044: * new AttributeChangeNotification(myMbean, sequenceNumber, timeStamp, msg,
045: * "myString", "String", oldValue, newValue);
046: * </CODE></BLOCKQUOTE>
047: */
048: public class AttributeChangeNotification extends Notification {
049: /* Serial version UID */
050: private static final long serialVersionUID = 535176054565814134L;
051:
052: /**
053: * Notification type denoting that the observed MBean attribute value has
054: * changed. The value of this notification type is jmx.attribute.change.
055: **/
056: public static final java.lang.String ATTRIBUTE_CHANGE = "jmx.attribute.change";
057:
058: /**
059: * The MBean attribute name.
060: */
061: private String attributeName = null;
062:
063: /**
064: * The MBean attribute type.
065: */
066: private String attributeType = null;
067:
068: /**
069: * The MBean attribute old value.
070: */
071: private Object oldValue = null;
072:
073: /**
074: * The MBean attribute new value.
075: */
076: private Object newValue = null;
077:
078: /**
079: * Constructs an attribute change notification object. In addition to
080: * the information common to all notification, the caller must supply
081: * the name and type of the attribute, as well as its old and new values.
082: *
083: * @param source The notification producer, that is, the MBean
084: * the attribute belongs to.
085: *
086: * @param sequenceNumber The notification sequence number within the source object.
087: *
088: * @param timeStamp The date at which the notification is being sent.
089: *
090: * @param msg A String containing the message of the notification.
091: *
092: * @param attributeName A String giving the name of the attribute.
093: *
094: * @param attributeType A String containing the type of the attribute.
095: *
096: * @param oldValue An object representing value of the attribute before the change.
097: *
098: * @param newValue An object representing value of the attribute after the change.
099: */
100: public AttributeChangeNotification(Object source,
101: long sequenceNumber, long timeStamp, String msg,
102: String attributeName, String attributeType,
103: Object oldValue, Object newValue) {
104: super (ATTRIBUTE_CHANGE, source, sequenceNumber, timeStamp, msg);
105: this .attributeName = attributeName;
106: this .attributeType = attributeType;
107: this .oldValue = oldValue;
108: this .newValue = newValue;
109: }
110:
111: /**
112: * Gets the name of the attribute which has changed.
113: *
114: * @return A String containing the name of the attribute.
115: */
116: public String getAttributeName() {
117: return attributeName;
118: }
119:
120: /**
121: * Gets the type of the attribute which has changed.
122: *
123: * @return A String containing the type of the attribute.
124: */
125: public String getAttributeType() {
126: return attributeType;
127: }
128:
129: /**
130: * Gets the old value of the attribute which has changed.
131: *
132: * @return An Object containing the old value of the attribute.
133: */
134: public Object getOldValue() {
135: return oldValue;
136: }
137:
138: /**
139: * Gets the new value of the attribute which has changed.
140: *
141: * @return An Object containing the new value of the attribute.
142: */
143: public Object getNewValue() {
144: return newValue;
145: }
146: }
|