1/* 2 * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25/* 26 * @author IBM Corp. 27 * 28 * Copyright IBM Corp. 1999-2000. All rights reserved. 29 */ 30 31package javax.management.modelmbean; 32 33import javax.management.Attribute; 34import javax.management.AttributeChangeNotification; 35import javax.management.ListenerNotFoundException; 36import javax.management.MBeanException; 37import javax.management.Notification; 38import javax.management.NotificationBroadcaster; 39import javax.management.NotificationListener; 40import javax.management.RuntimeOperationsException; 41 42/** 43 * This interface must be implemented by the ModelMBeans. An implementation of this interface 44 * must be shipped with every JMX Agent. 45 * <P> 46 * Java resources wishing to be manageable instantiate the ModelMBean using the MBeanServer's 47 * createMBean method. The resource then sets the ModelMBeanInfo (with Descriptors) for the ModelMBean 48 * instance. The attributes and operations exposed via the ModelMBeanInfo for the ModelMBean are accessible 49 * from MBeans, connectors/adaptors like other MBeans. Through the ModelMBeanInfo Descriptors, values and methods in 50 * the managed application can be defined and mapped to attributes and operations of the ModelMBean. 51 * This mapping can be defined during development in an XML formatted file or dynamically and 52 * programmatically at runtime. 53 * <P> 54 * Every ModelMBean which is instantiated in the MBeanServer becomes manageable: 55 * its attributes and operations 56 * become remotely accessible through the connectors/adaptors connected to that MBeanServer. 57 * A Java object cannot be registered in the MBeanServer unless it is a JMX compliant MBean. 58 * By instantiating a ModelMBean, resources are guaranteed that the MBean is valid. 59 * <P> 60 * MBeanException and RuntimeOperationsException must be thrown on every public method. This allows 61 * for wrapping exceptions from distributed communications (RMI, EJB, etc.). These exceptions do 62 * not have to be thrown by the implementation except in the scenarios described in the specification 63 * and javadoc. 64 * 65 * @since 1.5 66 */ 67 68public interface ModelMBeanNotificationBroadcaster extends NotificationBroadcaster 69{ 70 71 /** 72 * Sends a Notification which is passed in to the registered 73 * Notification listeners on the ModelMBean as a 74 * jmx.modelmbean.generic notification. 75 * 76 * @param ntfyObj The notification which is to be passed to 77 * the 'handleNotification' method of the listener object. 78 * 79 * @exception MBeanException Wraps a distributed communication Exception. 80 * @exception RuntimeOperationsException Wraps an IllegalArgumentException: 81 * The Notification object passed in parameter is null. 82 * 83 */ 84 85 public void sendNotification(Notification ntfyObj) 86 throws MBeanException, RuntimeOperationsException; 87 88 /** 89 * Sends a Notification which contains the text string that is passed in 90 * to the registered Notification listeners on the ModelMBean. 91 * 92 * @param ntfyText The text which is to be passed in the Notification to the 'handleNotification' 93 * method of the listener object. 94 * the constructed Notification will be: 95 * type "jmx.modelmbean.generic" 96 * source this ModelMBean instance 97 * sequence 1 98 * 99 * 100 * @exception MBeanException Wraps a distributed communication Exception. 101 * @exception RuntimeOperationsException Wraps an IllegalArgumentException: 102 * The Notification text string passed in parameter is null. 103 * 104 */ 105 public void sendNotification(String ntfyText) 106 throws MBeanException, RuntimeOperationsException; 107 108 /** 109 * Sends an attributeChangeNotification which is passed in to 110 * the registered attributeChangeNotification listeners on the 111 * ModelMBean. 112 * 113 * @param notification The notification which is to be passed 114 * to the 'handleNotification' method of the listener object. 115 * 116 * @exception MBeanException Wraps a distributed communication Exception. 117 * @exception RuntimeOperationsException Wraps an IllegalArgumentException: The AttributeChangeNotification object passed in parameter is null. 118 * 119 */ 120 public void sendAttributeChangeNotification(AttributeChangeNotification notification) 121 throws MBeanException, RuntimeOperationsException; 122 123 124 /** 125 * Sends an attributeChangeNotification which contains the old value and new value for the 126 * attribute to the registered AttributeChangeNotification listeners on the ModelMBean. 127 * 128 * @param oldValue The original value for the Attribute 129 * @param newValue The current value for the Attribute 130 * <PRE> 131 * The constructed attributeChangeNotification will be: 132 * type "jmx.attribute.change" 133 * source this ModelMBean instance 134 * sequence 1 135 * attributeName oldValue.getName() 136 * attributeType oldValue's class 137 * attributeOldValue oldValue.getValue() 138 * attributeNewValue newValue.getValue() 139 * </PRE> 140 * 141 * @exception MBeanException Wraps a distributed communication Exception. 142 * @exception RuntimeOperationsException Wraps an IllegalArgumentException: An Attribute object passed in parameter is null 143 * or the names of the two Attribute objects in parameter are not the same. 144 */ 145 public void sendAttributeChangeNotification(Attribute oldValue, Attribute newValue) 146 throws MBeanException, RuntimeOperationsException; 147 148 149 /** 150 * Registers an object which implements the NotificationListener interface as a listener. This 151 * object's 'handleNotification()' method will be invoked when any attributeChangeNotification is issued through 152 * or by the ModelMBean. This does not include other Notifications. They must be registered 153 * for independently. An AttributeChangeNotification will be generated for this attributeName. 154 * 155 * @param listener The listener object which will handles notifications emitted by the registered MBean. 156 * @param attributeName The name of the ModelMBean attribute for which to receive change notifications. 157 * If null, then all attribute changes will cause an attributeChangeNotification to be issued. 158 * @param handback The context to be sent to the listener with the notification when a notification is emitted. 159 * 160 * @exception IllegalArgumentException The listener cannot be null. 161 * @exception MBeanException Wraps a distributed communication Exception. 162 * @exception RuntimeOperationsException Wraps an IllegalArgumentException The attribute name passed in parameter does not exist. 163 * 164 * @see #removeAttributeChangeNotificationListener 165 */ 166 public void addAttributeChangeNotificationListener(NotificationListener listener, 167 String attributeName, 168 Object handback) 169 throws MBeanException, RuntimeOperationsException, IllegalArgumentException; 170 171 172 /** 173 * Removes a listener for attributeChangeNotifications from the RequiredModelMBean. 174 * 175 * @param listener The listener name which was handling notifications emitted by the registered MBean. 176 * This method will remove all information related to this listener. 177 * @param attributeName The attribute for which the listener no longer wants to receive attributeChangeNotifications. 178 * If null the listener will be removed for all attributeChangeNotifications. 179 * 180 * @exception ListenerNotFoundException The listener is not registered in the MBean or is null. 181 * @exception MBeanException Wraps a distributed communication Exception. 182 * @exception RuntimeOperationsException Wraps an IllegalArgumentException If the inAttributeName parameter does not 183 * correspond to an attribute name. 184 * 185 * @see #addAttributeChangeNotificationListener 186 */ 187 188 public void removeAttributeChangeNotificationListener(NotificationListener listener, 189 String attributeName) 190 throws MBeanException, RuntimeOperationsException, ListenerNotFoundException; 191 192} 193