/* * Copyright 1999-2008 Sun Microsystems, Inc. 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. Sun designates this * particular file as subject to the "Classpath" exception as provided * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, * CA 95054 USA or visit www.sun.com if you need additional information or * have any questions. */ package javax.management; // java import import java.util.Set; import java.io.ObjectInputStream; // RI import import javax.management.loading.ClassLoaderRepository; /** *

This is the interface for MBean manipulation on the agent * side. It contains the methods necessary for the creation, * registration, and deletion of MBeans as well as the access methods * for registered MBeans. This is the core component of the JMX * infrastructure.

* *

User code does not usually implement this interface. Instead, * an object that implements this interface is obtained with one of * the methods in the {@link javax.management.MBeanServerFactory} class.

* *

Every MBean which is added to the MBean server becomes * manageable: its attributes and operations become remotely * accessible through the connectors/adaptors connected to that MBean * server. A Java object cannot be registered in the MBean server * unless it is a JMX compliant MBean.

* *

When an MBean is registered or unregistered in the * MBean server a {@link javax.management.MBeanServerNotification * MBeanServerNotification} Notification is emitted. To register an * object as listener to MBeanServerNotifications you should call the * MBean server method {@link #addNotificationListener * addNotificationListener} with ObjectName the * ObjectName of the {@link * javax.management.MBeanServerDelegate MBeanServerDelegate}. This * ObjectName is:
* JMImplementation:type=MBeanServerDelegate.

* *

An object obtained from the {@link * MBeanServerFactory#createMBeanServer(String) createMBeanServer}, {@link * MBeanServerFactory#createNamedMBeanServer(String,String) createNamedMBeanServer}, * {@link * MBeanServerFactory#newMBeanServer(String) newMBeanServer}, or * {@link * MBeanServerFactory#newNamedMBeanServer(String,String) newNamedMBeanServer} * methods of the {@link MBeanServerFactory} class applies security * checks to its methods, as follows.

* *

First, if there is no security manager ({@link * System#getSecurityManager()} is null), then an implementation of * this interface is free not to make any checks.

* *

Assuming that there is a security manager, or that the * implementation chooses to make checks anyway, the checks are made * as detailed below. * In what follows, and unless otherwise specified: *

* * *

If a security check fails, the method throws {@link * SecurityException}.

* *

For methods that can throw {@link InstanceNotFoundException}, * this exception is thrown for a non-existent MBean, regardless of * permissions. This is because a non-existent MBean has no * className.

* * * * @since 1.5 */ /* DELETED: * *

  • For the {@link #isRegistered isRegistered} method, the * caller's permissions must imply {@link * MBeanPermission#MBeanPermission(String,String,ObjectName,String) * MBeanPermission(null, null, name, "isRegistered")}.

    */ public interface MBeanServer extends MBeanServerConnection { /** * {@inheritDoc} *

    If this method successfully creates an MBean, a notification * is sent as described above.

    * * @throws RuntimeOperationsException {@inheritDoc} * @throws RuntimeMBeanException {@inheritDoc} * @throws RuntimeErrorException {@inheritDoc} */ public ObjectInstance createMBean(String className, ObjectName name) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException; /** * {@inheritDoc} *

    If this method successfully creates an MBean, a notification * is sent as described above.

    * * @throws RuntimeOperationsException {@inheritDoc} * @throws RuntimeMBeanException {@inheritDoc} * @throws RuntimeErrorException {@inheritDoc} */ public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException; /** * {@inheritDoc} *

    If this method successfully creates an MBean, a notification * is sent as described above.

    * * @throws RuntimeOperationsException {@inheritDoc} * @throws RuntimeMBeanException {@inheritDoc} * @throws RuntimeErrorException {@inheritDoc} */ public ObjectInstance createMBean(String className, ObjectName name, Object params[], String signature[]) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException; /** * {@inheritDoc} *

    If this method successfully creates an MBean, a notification * is sent as described above.

    * * @throws RuntimeOperationsException {@inheritDoc} * @throws RuntimeMBeanException {@inheritDoc} * @throws RuntimeErrorException {@inheritDoc} */ public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object params[], String signature[]) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException; /** *

    Registers a pre-existing object as an MBean with the MBean * server. If the object name given is null, the * MBean must provide its own name in one or both of two ways: by implementing the {@link * javax.management.MBeanRegistration MBeanRegistration} interface * and returning the name from the {@link * MBeanRegistration#preRegister preRegister} method; or by defining * an {@code objectNameTemplate} field in its {@link Descriptor}, * typically using the {@link ObjectNameTemplate @ObjectNameTemplate} * annotation.

    * *

    If this method successfully registers an MBean, a notification * is sent as described above.

    * * @param object The MBean to be registered as an MBean. * @param name The object name of the MBean. May be null. * * @return An ObjectInstance, containing the * ObjectName and the Java class name of the newly * registered MBean. If the contained ObjectName * is n, the contained Java class name is * {@link #getMBeanInfo getMBeanInfo(n)}.getClassName(). * * @exception InstanceAlreadyExistsException The MBean is already * under the control of the MBean server. * @exception MBeanRegistrationException The * preRegister (MBeanRegistration * interface) method of the MBean has thrown an exception. The * MBean will not be registered. * @exception RuntimeMBeanException If the postRegister * (MBeanRegistration interface) method of the MBean throws a * RuntimeException, the registerMBean method will * throw a RuntimeMBeanException, although the MBean * registration succeeded. In such a case, the MBean will be actually * registered even though the registerMBean method * threw an exception. Note that RuntimeMBeanException can * also be thrown by preRegister, in which case the MBean * will not be registered. * @exception RuntimeErrorException If the postRegister * (MBeanRegistration interface) method of the MBean throws an * Error, the registerMBean method will * throw a RuntimeErrorException, although the MBean * registration succeeded. In such a case, the MBean will be actually * registered even though the registerMBean method * threw an exception. Note that RuntimeErrorException can * also be thrown by preRegister, in which case the MBean * will not be registered. * @exception NotCompliantMBeanException This object is not a JMX * compliant MBean * @exception RuntimeOperationsException Wraps a * java.lang.IllegalArgumentException: The object * passed in parameter is null or no object name is specified. * @see javax.management.MBeanRegistration */ public ObjectInstance registerMBean(Object object, ObjectName name) throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException; /** * {@inheritDoc} * *

    If this method successfully unregisters an MBean, a notification * is sent as described above.

    * * @throws RuntimeOperationsException {@inheritDoc} * @throws RuntimeMBeanException {@inheritDoc} * @throws RuntimeErrorException {@inheritDoc} */ public void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException; // doc comment inherited from MBeanServerConnection public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException; /** * {@inheritDoc} * @throws RuntimeOperationsException {@inheritDoc} */ public Set queryMBeans(ObjectName name, QueryExp query); /** * {@inheritDoc} * @throws RuntimeOperationsException {@inheritDoc} */ public Set queryNames(ObjectName name, QueryExp query); // doc comment inherited from MBeanServerConnection /** * @throws RuntimeOperationsException {@inheritDoc} */ public boolean isRegistered(ObjectName name); /** * Returns the number of MBeans registered in the MBean server. * * @return the number of registered MBeans, wrapped in an Integer. * If the caller's permissions are restricted, this number may * be greater than the number of MBeans the caller can access. */ public Integer getMBeanCount(); // doc comment inherited from MBeanServerConnection /** * @throws RuntimeOperationsException {@inheritDoc} */ public Object getAttribute(ObjectName name, String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException; // doc comment inherited from MBeanServerConnection /** * @throws RuntimeOperationsException {@inheritDoc} */ public AttributeList getAttributes(ObjectName name, String[] attributes) throws InstanceNotFoundException, ReflectionException; // doc comment inherited from MBeanServerConnection /** * @throws RuntimeOperationsException {@inheritDoc} */ public void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException; // doc comment inherited from MBeanServerConnection /** * @throws RuntimeOperationsException {@inheritDoc} */ public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException, ReflectionException; // doc comment inherited from MBeanServerConnection public Object invoke(ObjectName name, String operationName, Object params[], String signature[]) throws InstanceNotFoundException, MBeanException, ReflectionException; // doc comment inherited from MBeanServerConnection public String getDefaultDomain(); // doc comment inherited from MBeanServerConnection public String[] getDomains(); // doc comment inherited from MBeanServerConnection, plus: /** * {@inheritDoc} * If the source of the notification * is a reference to an MBean object, the MBean server will replace it * by that MBean's ObjectName. Otherwise the source is unchanged. */ public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException; /** * {@inheritDoc} * @throws RuntimeOperationsException {@inheritDoc} */ public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException; // doc comment inherited from MBeanServerConnection public void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException; // doc comment inherited from MBeanServerConnection public void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException; // doc comment inherited from MBeanServerConnection public void removeNotificationListener(ObjectName name, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException; // doc comment inherited from MBeanServerConnection public void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException; // doc comment inherited from MBeanServerConnection public MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException, ReflectionException; // doc comment inherited from MBeanServerConnection public boolean isInstanceOf(ObjectName name, String className) throws InstanceNotFoundException; /** *

    Instantiates an object using the list of all class loaders * registered in the MBean server's {@link * javax.management.loading.ClassLoaderRepository Class Loader * Repository}. The object's class should have a public * constructor. This method returns a reference to the newly * created object. The newly created object is not registered in * the MBean server.

    * *

    This method is equivalent to {@link * #instantiate(String,Object[],String[]) * instantiate(className, (Object[]) null, (String[]) null)}.

    * * @param className The class name of the object to be instantiated. * * @return The newly instantiated object. * * @exception ReflectionException Wraps a * java.lang.ClassNotFoundException or the * java.lang.Exception that occurred when trying to * invoke the object's constructor. * @exception MBeanException The constructor of the object has * thrown an exception * @exception RuntimeOperationsException Wraps a * java.lang.IllegalArgumentException: The className * passed in parameter is null. */ public Object instantiate(String className) throws ReflectionException, MBeanException; /** *

    Instantiates an object using the class Loader specified by its * ObjectName. If the loader name is null, the * ClassLoader that loaded the MBean Server will be used. The * object's class should have a public constructor. This method * returns a reference to the newly created object. The newly * created object is not registered in the MBean server.

    * *

    This method is equivalent to {@link * #instantiate(String,ObjectName,Object[],String[]) * instantiate(className, loaderName, (Object[]) null, (String[]) * null)}.

    * * @param className The class name of the MBean to be instantiated. * @param loaderName The object name of the class loader to be used. * * @return The newly instantiated object. * * @exception ReflectionException Wraps a * java.lang.ClassNotFoundException or the * java.lang.Exception that occurred when trying to * invoke the object's constructor. * @exception MBeanException The constructor of the object has * thrown an exception. * @exception InstanceNotFoundException The specified class loader * is not registered in the MBeanServer. * @exception RuntimeOperationsException Wraps a * java.lang.IllegalArgumentException: The className * passed in parameter is null. */ public Object instantiate(String className, ObjectName loaderName) throws ReflectionException, MBeanException, InstanceNotFoundException; /** *

    Instantiates an object using the list of all class loaders * registered in the MBean server {@link * javax.management.loading.ClassLoaderRepository Class Loader * Repository}. The object's class should have a public * constructor. The call returns a reference to the newly created * object. The newly created object is not registered in the * MBean server.

    * * @param className The class name of the object to be instantiated. * @param params An array containing the parameters of the * constructor to be invoked. * @param signature An array containing the signature of the * constructor to be invoked. * * @return The newly instantiated object. * * @exception ReflectionException Wraps a * java.lang.ClassNotFoundException or the * java.lang.Exception that occurred when trying to * invoke the object's constructor. * @exception MBeanException The constructor of the object has * thrown an exception * @exception RuntimeOperationsException Wraps a * java.lang.IllegalArgumentException: The className * passed in parameter is null. */ public Object instantiate(String className, Object params[], String signature[]) throws ReflectionException, MBeanException; /** *

    Instantiates an object. The class loader to be used is * identified by its object name. If the object name of the loader * is null, the ClassLoader that loaded the MBean server will be * used. The object's class should have a public constructor. * The call returns a reference to the newly created object. The * newly created object is not registered in the MBean server.

    * * @param className The class name of the object to be instantiated. * @param params An array containing the parameters of the * constructor to be invoked. * @param signature An array containing the signature of the * constructor to be invoked. * @param loaderName The object name of the class loader to be used. * * @return The newly instantiated object. * * @exception ReflectionException Wraps a java.lang.ClassNotFoundException or the java.lang.Exception that * occurred when trying to invoke the object's constructor. * @exception MBeanException The constructor of the object has * thrown an exception * @exception InstanceNotFoundException The specified class loader * is not registered in the MBean server. * @exception RuntimeOperationsException Wraps a * java.lang.IllegalArgumentException: The className * passed in parameter is null. */ public Object instantiate(String className, ObjectName loaderName, Object params[], String signature[]) throws ReflectionException, MBeanException, InstanceNotFoundException; /** *

    De-serializes a byte array in the context of the class loader * of an MBean.

    * * @param name The name of the MBean whose class loader should be * used for the de-serialization. * @param data The byte array to be de-sererialized. * * @return The de-serialized object stream. * * @exception InstanceNotFoundException The MBean specified is not * found. * @exception OperationsException Any of the usual Input/Output * related exceptions. * * @deprecated Use {@link #getClassLoaderFor getClassLoaderFor} to * obtain the appropriate class loader for deserialization. */ @Deprecated public ObjectInputStream deserialize(ObjectName name, byte[] data) throws InstanceNotFoundException, OperationsException; /** *

    De-serializes a byte array in the context of a given MBean * class loader. The class loader is found by loading the class * className through the {@link * javax.management.loading.ClassLoaderRepository Class Loader * Repository}. The resultant class's class loader is the one to * use. * * @param className The name of the class whose class loader should be * used for the de-serialization. * @param data The byte array to be de-sererialized. * * @return The de-serialized object stream. * * @exception OperationsException Any of the usual Input/Output * related exceptions. * @exception ReflectionException The specified class could not be * loaded by the class loader repository * * @deprecated Use {@link #getClassLoaderRepository} to obtain the * class loader repository and use it to deserialize. */ @Deprecated public ObjectInputStream deserialize(String className, byte[] data) throws OperationsException, ReflectionException; /** *

    De-serializes a byte array in the context of a given MBean * class loader. The class loader is the one that loaded the * class with name "className". The name of the class loader to * be used for loading the specified class is specified. If null, * the MBean Server's class loader will be used.

    * * @param className The name of the class whose class loader should be * used for the de-serialization. * @param data The byte array to be de-sererialized. * @param loaderName The name of the class loader to be used for * loading the specified class. If null, the MBean Server's class * loader will be used. * * @return The de-serialized object stream. * * @exception InstanceNotFoundException The specified class loader * MBean is not found. * @exception OperationsException Any of the usual Input/Output * related exceptions. * @exception ReflectionException The specified class could not be * loaded by the specified class loader. * * @deprecated Use {@link #getClassLoader getClassLoader} to obtain * the class loader for deserialization. */ @Deprecated public ObjectInputStream deserialize(String className, ObjectName loaderName, byte[] data) throws InstanceNotFoundException, OperationsException, ReflectionException; /** *

    Return the {@link java.lang.ClassLoader} that was used for loading * the class of the named MBean. If the MBean implements the {@link * DynamicWrapperMBean} interface, then the returned value is the * result of the {@link DynamicWrapperMBean#getWrappedClassLoader()} * method.

    * * @param mbeanName The ObjectName of the MBean. * * @return The ClassLoader used for that MBean. If l * is the value specified by the rules above, and r is the * returned value, then either: * *
      *
    • r is identical to l; or *
    • the result of r{@link * ClassLoader#loadClass(String) .loadClass(s)} is the * same as l{@link ClassLoader#loadClass(String) * .loadClass(s)} for any string s. *
    * * What this means is that the ClassLoader may be wrapped in * another ClassLoader for security or other reasons. * * @exception InstanceNotFoundException if the named MBean is not found. * */ public ClassLoader getClassLoaderFor(ObjectName mbeanName) throws InstanceNotFoundException; /** *

    Return the named {@link java.lang.ClassLoader}.

    * * @param loaderName The ObjectName of the ClassLoader. May be * null, in which case the MBean server's own ClassLoader is * returned. * * @return The named ClassLoader. If l is the actual * ClassLoader with that name, and r is the returned * value, then either: * *
      *
    • r is identical to l; or *
    • the result of r{@link * ClassLoader#loadClass(String) .loadClass(s)} is the * same as l{@link ClassLoader#loadClass(String) * .loadClass(s)} for any string s. *
    * * What this means is that the ClassLoader may be wrapped in * another ClassLoader for security or other reasons. * * @exception InstanceNotFoundException if the named ClassLoader is * not found. * */ public ClassLoader getClassLoader(ObjectName loaderName) throws InstanceNotFoundException; /** *

    Return the ClassLoaderRepository for this MBeanServer. * @return The ClassLoaderRepository for this MBeanServer. * */ public ClassLoaderRepository getClassLoaderRepository(); }