File Doc Category Size Date Package
MBeanServer.java API Doc Java SE 6 API 29705 Tue Jun 10 00:26:12 BST 2008 javax.management

MBeanServer

public interface MBeanServer implements MBeanServerConnection

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 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} or {@link MBeanServerFactory#newMBeanServer(String) newMBeanServer} 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, className is the string returned by {@link MBeanInfo#getClassName()} for the target MBean.

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.

For the {@link #invoke invoke} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, operationName, name, "invoke")}.
For the {@link #getAttribute getAttribute} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, attribute, name, "getAttribute")}.
For the {@link #getAttributes getAttributes} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "getAttribute")}. Additionally, for each attribute a in the {@link AttributeList}, if the caller's permissions do not imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, a, name, "getAttribute")}, the MBean server will behave as if that attribute had not been in the supplied list.
For the {@link #setAttribute setAttribute} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, attrName, name, "setAttribute")}, where attrName is {@link Attribute#getName() attribute.getName()}.
For the {@link #setAttributes setAttributes} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "setAttribute")}. Additionally, for each attribute a in the {@link AttributeList}, if the caller's permissions do not imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, a, name, "setAttribute")}, the MBean server will behave as if that attribute had not been in the supplied list.
For the addNotificationListener methods, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "addNotificationListener")}.
For the removeNotificationListener methods, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "removeNotificationListener")}.
For the {@link #getMBeanInfo getMBeanInfo} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "getMBeanInfo")}.
For the {@link #getObjectInstance getObjectInstance} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "getObjectInstance")}.
For the {@link #isInstanceOf isInstanceOf} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "isInstanceOf")}.
For the {@link #queryMBeans queryMBeans} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(null, null, name, "queryMBeans")}. Additionally, for each MBean that matches name, if the caller's permissions do not imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "queryMBeans")}, the MBean server will behave as if that MBean did not exist.

Certain query elements perform operations on the MBean server. If the caller does not have the required permissions for a given MBean, that MBean will not be included in the result of the query. The standard query elements that are affected are {@link Query#attr(String)}, {@link Query#attr(String,String)}, and {@link Query#classattr()}.
For the {@link #queryNames queryNames} method, the checks are the same as for queryMBeans except that "queryNames" is used instead of "queryMBeans" in the MBeanPermission objects. Note that a "queryMBeans" permission implies the corresponding "queryNames" permission.
For the {@link #getDomains getDomains} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(null, null, name, "getDomains")}. Additionally, for each domain d in the returned array, if the caller's permissions do not imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(null, null, new ObjectName("d:x=x"), "getDomains")}, the domain is eliminated from the array. Here, x=x is any key=value pair, needed to satisfy ObjectName's constructor but not otherwise relevant.
For the {@link #getClassLoader getClassLoader} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, loaderName, "getClassLoader")}.
For the {@link #getClassLoaderFor getClassLoaderFor} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, mbeanName, "getClassLoaderFor")}.
For the {@link #getClassLoaderRepository getClassLoaderRepository} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(null, null, null, "getClassLoaderRepository")}.
For the deprecated deserialize methods, the required permissions are the same as for the methods that replace them.
For the instantiate methods, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, null, "instantiate")}.
For the {@link #registerMBean registerMBean} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "registerMBean")}. Here className is the string returned by {@link MBeanInfo#getClassName()} for an object of this class.
If the MBeanPermission check succeeds, the MBean's class is validated by checking that its {@link java.security.ProtectionDomain ProtectionDomain} implies {@link MBeanTrustPermission#MBeanTrustPermission(String) MBeanTrustPermission("register")}.

Finally, if the name argument is null, another MBeanPermission check is made using the ObjectName returned by {@link MBeanRegistration#preRegister MBeanRegistration.preRegister}.
For the createMBean methods, the caller's permissions must imply the permissions needed by the equivalent instantiate followed by registerMBean.
For the {@link #unregisterMBean unregisterMBean} method, the caller's permissions must imply {@link MBeanPermission#MBeanPermission(String,String,ObjectName,String) MBeanPermission(className, null, name, "unregisterMBean")}.

since: 1.5

Fields Summary
Constructors Summary
Methods Summary
public void addNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)
public void addNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener, javax.management.NotificationFilter filter, java.lang.Object handback)
public javax.management.ObjectInstance createMBean(java.lang.String className, javax.management.ObjectName name)
public javax.management.ObjectInstance createMBean(java.lang.String className, javax.management.ObjectName name, javax.management.ObjectName loaderName)
public javax.management.ObjectInstance createMBean(java.lang.String className, javax.management.ObjectName name, java.lang.Object[] params, java.lang.String[] signature)
public javax.management.ObjectInstance createMBean(java.lang.String className, javax.management.ObjectName name, javax.management.ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature)
public java.io.ObjectInputStream deserialize(javax.management.ObjectName name, byte[] data)
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.
public java.io.ObjectInputStream deserialize(java.lang.String className, byte[] data)
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.
public java.io.ObjectInputStream deserialize(java.lang.String className, javax.management.ObjectName loaderName, byte[] data)
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.
public java.lang.Object getAttribute(javax.management.ObjectName name, java.lang.String attribute)
public javax.management.AttributeList getAttributes(javax.management.ObjectName name, java.lang.String[] attributes)
public java.lang.ClassLoader getClassLoader(javax.management.ObjectName loaderName)
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.
since.unbundled
JMX 1.2
public java.lang.ClassLoader getClassLoaderFor(javax.management.ObjectName mbeanName)
Return the {@link java.lang.ClassLoader} that was used for loading the class of the named MBean.
param
mbeanName The ObjectName of the MBean.
return
The ClassLoader used for that MBean. If l is the MBean's actual ClassLoader, 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.
since.unbundled
JMX 1.2
public javax.management.loading.ClassLoaderRepository getClassLoaderRepository()
Return the ClassLoaderRepository for this MBeanServer.
return
The ClassLoaderRepository for this MBeanServer.
since.unbundled
JMX 1.2
public java.lang.String getDefaultDomain()
public java.lang.String[] getDomains()
public java.lang.Integer getMBeanCount()
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 javax.management.MBeanInfo getMBeanInfo(javax.management.ObjectName name)
public javax.management.ObjectInstance getObjectInstance(javax.management.ObjectName name)
public java.lang.Object instantiate(java.lang.String className)
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 java.lang.Object instantiate(java.lang.String className, javax.management.ObjectName loaderName)
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 java.lang.Object instantiate(java.lang.String className, java.lang.Object[] params, java.lang.String[] signature)
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 java.lang.Object instantiate(java.lang.String className, javax.management.ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature)
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 java.lang.Object invoke(javax.management.ObjectName name, java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature)
public boolean isInstanceOf(javax.management.ObjectName name, java.lang.String className)
public boolean isRegistered(javax.management.ObjectName name)
public java.util.Set queryMBeans(javax.management.ObjectName name, javax.management.QueryExp query)
public java.util.Set queryNames(javax.management.ObjectName name, javax.management.QueryExp query)
public javax.management.ObjectInstance registerMBean(java.lang.Object object, javax.management.ObjectName name)
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 by implementing the {@link javax.management.MBeanRegistration MBeanRegistration} interface and returning the name from the {@link MBeanRegistration#preRegister preRegister} method.
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
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.
public void removeNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener)
public void removeNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener, javax.management.NotificationFilter filter, java.lang.Object handback)
public void removeNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener)
public void removeNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)
public void setAttribute(javax.management.ObjectName name, javax.management.Attribute attribute)
public javax.management.AttributeList setAttributes(javax.management.ObjectName name, javax.management.AttributeList attributes)
public void unregisterMBean(javax.management.ObjectName name)