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
/* * @(#)file ModelMBean.java * @(#)author IBM Corp. * @(#)version 1.22 * @(#)lastedit 05/11/17 */ /* * Copyright IBM Corp. 1999-2000. All rights reserved. * * The program is provided "as is" without any warranty express or implied, * including the warranty of non-infringement and the implied warranties of * merchantibility and fitness for a particular purpose. IBM will not be * liable for any damages suffered by you or any third party claim against * you regarding the Program. * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * This software is the proprietary information of Sun Microsystems, Inc. * Use is subject to license terms. * * Copyright 2006 Sun Microsystems, Inc. Tous droits reserves. * Ce logiciel est propriete de Sun Microsystems, Inc. * Distribue par des licences qui en restreignent l'utilisation. * */ package javax.management.modelmbean; import javax.management.*; import javax.management.InstanceNotFoundException; /** * This interface must be implemented by the ModelMBeans. An implementation of this interface * must be shipped with every JMX Agent. * <P> * Java resources wishing to be manageable instantiate the ModelMBean using the MBeanServer's * createMBean method. The resource then sets the ModelMBeanInfo (with Descriptors) for the ModelMBean * instance. The attributes and operations exposed via the ModelMBeanInfo for the ModelMBean are accessible * from MBeans, connectors/adaptors like other MBeans. Through the ModelMBeanInfo Descriptors, values and methods in * the managed application can be defined and mapped to attributes and operations of the ModelMBean. * This mapping can be defined during development in an XML formatted file or dynamically and * programmatically at runtime. * <P> * Every ModelMBean which is instantiated in the MBeanServer becomes manageable: * its attributes and operations * become remotely accessible through the connectors/adaptors connected to that MBeanServer. * A Java object cannot be registered in the MBeanServer unless it is a JMX compliant MBean. * By instantiating a ModelMBean, resources are guaranteed that the MBean is valid. * <P> * MBeanException and RuntimeOperationsException must be thrown on every public method. This allows * for wrapping exceptions from distributed communications (RMI, EJB, etc.). These exceptions do * not have to be thrown by the implementation except in the scenarios described in the specification * and javadoc. * * @since 1.5 */ public interface ModelMBean extends DynamicMBean, PersistentMBean, ModelMBeanNotificationBroadcaster { /** * Initializes a ModelMBean object using ModelMBeanInfo passed in. * This method makes it possible to set a customized ModelMBeanInfo on * the ModelMBean as long as it is not registered with the MBeanServer. * <br> * Once the ModelMBean's ModelMBeanInfo (with Descriptors) are * customized and set on the ModelMBean, the ModelMBean can be * registered with the MBeanServer. * <P> * If the ModelMBean is currently registered, this method throws * a {@link javax.management.RuntimeOperationsException} wrapping an * {@link IllegalStateException} * * @param inModelMBeanInfo The ModelMBeanInfo object to be used * by the ModelMBean. * * @exception MBeanException Wraps a distributed communication * Exception. * @exception RuntimeOperationsException * <ul><li>Wraps an {@link IllegalArgumentException} if * the MBeanInfo passed in parameter is null.</li> * <li>Wraps an {@link IllegalStateException} if the ModelMBean * is currently registered in the MBeanServer.</li> * </ul> * **/ public void setModelMBeanInfo(ModelMBeanInfo inModelMBeanInfo) throws MBeanException, RuntimeOperationsException; /** * Sets the instance handle of the object against which to * execute all methods in this ModelMBean management interface * (MBeanInfo and Descriptors). * * @param mr Object that is the managed resource * @param mr_type The type of reference for the managed resource. Can be: ObjectReference, * Handle, IOR, EJBHandle, RMIReference. * If the MBeanServer cannot process the mr_type passed in, an InvalidTargetTypeException * will be thrown. * * * @exception MBeanException The initializer of the object has thrown an exception. * @exception RuntimeOperationsException Wraps an IllegalArgumentException: * The managed resource type passed in parameter is null. * @exception InstanceNotFoundException The managed resource object could not be found * @exception InvalidTargetObjectTypeException The managed resource type cannot be processed by the * ModelMBean or JMX Agent. */ public void setManagedResource(Object mr, String mr_type) throws MBeanException, RuntimeOperationsException, InstanceNotFoundException, InvalidTargetObjectTypeException ; }