/*
* Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.management;
/**
* Provides definitions of the attribute change notifications sent by MBeans.
* <P>
* It's up to the MBean owning the attribute of interest to create and send
* attribute change notifications when the attribute change occurs.
* So the <CODE>NotificationBroadcaster</CODE> interface has to be implemented
* by any MBean for which an attribute change is of interest.
* <P>
* Example:
* If an MBean called <CODE>myMbean</CODE> needs to notify registered listeners
* when its attribute:
* <BLOCKQUOTE><CODE>
* String myString
* </CODE></BLOCKQUOTE>
* is modified, <CODE>myMbean</CODE> creates and emits the following notification:
* <BLOCKQUOTE><CODE>
* new AttributeChangeNotification(myMbean, sequenceNumber, timeStamp, msg,
* "myString", "String", oldValue, newValue);
* </CODE></BLOCKQUOTE>
*
* @since 1.5
*/
public class AttributeChangeNotification extends javax.management.Notification {
/* Serial version */
private static final long serialVersionUID = 535176054565814134L;
/**
* Notification type which indicates that the observed MBean attribute value has changed.
* <BR>The value of this type string is <CODE>jmx.attribute.change</CODE>.
*/
public static final String ATTRIBUTE_CHANGE = "jmx.attribute.change";
/**
* @serial The MBean attribute name.
*/
private String attributeName = null;
/**
* @serial The MBean attribute type.
*/
private String attributeType = null;
/**
* @serial The MBean attribute old value.
*/
private Object oldValue = null;
/**
* @serial The MBean attribute new value.
*/
private Object newValue = null;
/**
* Constructs an attribute change notification object.
* In addition to the information common to all notification, the caller must supply the name and type
* of the attribute, as well as its old and new values.
*
* @param source The notification producer, that is, the MBean the attribute belongs to.
* @param sequenceNumber The notification sequence number within the source object.
* @param timeStamp The date at which the notification is being sent.
* @param msg A String containing the message of the notification.
* @param attributeName A String giving the name of the attribute.
* @param attributeType A String containing the type of the attribute.
* @param oldValue An object representing value of the attribute before the change.
* @param newValue An object representing value of the attribute after the change.
*/
public AttributeChangeNotification(Object source, long sequenceNumber, long timeStamp, String msg,
String attributeName, String attributeType, Object oldValue, Object newValue) {
super(AttributeChangeNotification.ATTRIBUTE_CHANGE, source, sequenceNumber, timeStamp, msg);
this.attributeName = attributeName;
this.attributeType = attributeType;
this.oldValue = oldValue;
this.newValue = newValue;
}
/**
* Gets the name of the attribute which has changed.
*
* @return A String containing the name of the attribute.
*/
public String getAttributeName() {
return attributeName;
}
/**
* Gets the type of the attribute which has changed.
*
* @return A String containing the type of the attribute.
*/
public String getAttributeType() {
return attributeType;
}
/**
* Gets the old value of the attribute which has changed.
*
* @return An Object containing the old value of the attribute.
*/
public Object getOldValue() {
return oldValue;
}
/**
* Gets the new value of the attribute which has changed.
*
* @return An Object containing the new value of the attribute.
*/
public Object getNewValue() {
return newValue;
}
}