Interface: javax.management.MBeanServer (java/j2se/1.6) javadoc api

Interface: 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 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 MBeanServerNotification Notification is emitted. To register an object as listener to MBeanServerNotifications you should call the MBean server method addNotificationListener with ObjectName the ObjectName of the MBeanServerDelegate. This ObjectName is:
JMImplementation:type=MBeanServerDelegate.

An object obtained from the createMBeanServer or newMBeanServer methods of the javax.management.MBeanServerFactory class applies security checks to its methods, as follows.

First, if there is no security manager (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 javax.management.MBeanInfo.getClassName() for the target MBean.

If a security check fails, the method throws SecurityException.

For methods that can throw javax.management.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 invoke method, the caller's permissions must imply MBeanPermission(className, operationName, name, "invoke").
For the getAttribute method, the caller's permissions must imply MBeanPermission(className, attribute, name, "getAttribute").
For the getAttributes method, the caller's permissions must imply MBeanPermission(className, null, name, "getAttribute"). Additionally, for each attribute a in the javax.management.AttributeList, if the caller's permissions do not imply MBeanPermission(className, a, name, "getAttribute"), the MBean server will behave as if that attribute had not been in the supplied list.
For the setAttribute method, the caller's permissions must imply MBeanPermission(className, attrName, name, "setAttribute"), where attrName is attribute.getName().
For the setAttributes method, the caller's permissions must imply MBeanPermission(className, null, name, "setAttribute"). Additionally, for each attribute a in the javax.management.AttributeList, if the caller's permissions do not imply 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 MBeanPermission(className, null, name, "addNotificationListener").
For the removeNotificationListener methods, the caller's permissions must imply MBeanPermission(className, null, name, "removeNotificationListener").
For the getMBeanInfo method, the caller's permissions must imply MBeanPermission(className, null, name, "getMBeanInfo").
For the getObjectInstance method, the caller's permissions must imply MBeanPermission(className, null, name, "getObjectInstance").
For the isInstanceOf method, the caller's permissions must imply MBeanPermission(className, null, name, "isInstanceOf").
For the queryMBeans method, the caller's permissions must imply MBeanPermission(null, null, name, "queryMBeans"). Additionally, for each MBean that matches name, if the caller's permissions do not imply 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 javax.management.Query.attr(java.lang.String), javax.management.Query.attr(java.lang.String, java.lang.String), and javax.management.Query.classattr().
For the 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 getDomains method, the caller's permissions must imply MBeanPermission(null, null, name, "getDomains"). Additionally, for each domain d in the returned array, if the caller's permissions do not imply 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 getClassLoader method, the caller's permissions must imply MBeanPermission(className, null, loaderName, "getClassLoader").
For the getClassLoaderFor method, the caller's permissions must imply MBeanPermission(className, null, mbeanName, "getClassLoaderFor").
For the getClassLoaderRepository method, the caller's permissions must imply 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 MBeanPermission(className, null, null, "instantiate").
For the registerMBean method, the caller's permissions must imply MBeanPermission(className, null, name, "registerMBean"). Here className is the string returned by javax.management.MBeanInfo.getClassName() for an object of this class.
If the MBeanPermission check succeeds, the MBean's class is validated by checking that its ProtectionDomain implies MBeanTrustPermission("register").

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

Since:: @since 1.5

Inheritance

Implements:

MBeanServerConnection

Methods

addNotificationListenertop

public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException

Adds a listener to a registered MBean.

A notification emitted by an MBean will be forwarded by the MBeanServer to the listener. 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.
Parameters:
@param name The name of the MBean on which the listener should be added.
@param listener The listener object which will handle the notifications emitted by the registered MBean.
@param filter The filter object. If filter is null, no filtering will be performed before handling notifications.
@param handback The context to be sent to the listener when a notification is emitted.
Exceptions:
@exception InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.

Specified by:
addNotificationListener from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

addNotificationListenertop

public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException

Adds a listener to a registered MBean.

A notification emitted by an MBean will be forwarded by the MBeanServer to the listener. 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.

The listener object that receives notifications is the one that is registered with the given name at the time this method is called. Even if it is subsequently unregistered, it will continue to receive notifications.
Parameters:
@param name The name of the MBean on which the listener should be added.
@param listener The object name of the listener which will handle the notifications emitted by the registered MBean.
@param filter The filter object. If filter is null, no filtering will be performed before handling notifications.
@param handback The context to be sent to the listener when a notification is emitted.
Exceptions:
@exception InstanceNotFoundException The MBean name of the notification listener or of the notification broadcaster does not match any of the registered MBeans.

Specified by:
addNotificationListener from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

createMBeantop

public ObjectInstance createMBean(String className, ObjectName name) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException

Instantiates and registers an MBean in the MBean server. The MBean server will use its Default Loader Repository to load the class of the MBean. An object name is associated to the MBean. If the object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

This method is equivalent to createMBean(className, name, (Object[]) null, (String[]) null).
Parameters:
@param className The class name of the MBean to be instantiated.
@param name The object name of the MBean. May be null.
Return:
@return An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n) .getClassName().
Exceptions:
@exception ReflectionException Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
@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 MBeanException The constructor of the MBean has thrown an exception
@exception NotCompliantMBeanException This class is not a JMX compliant MBean

Specified by:
createMBean from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

createMBeantop

public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException

Instantiates and registers an MBean in the MBean server. The class loader to be used is identified by its object name. An object name is associated to the MBean. If the object name of the loader is null, the ClassLoader that loaded the MBean server will be used. If the MBean's object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

This method is equivalent to createMBean(className, name, loaderName, (Object[]) null, (String[]) null).
Parameters:
@param className The class name of the MBean to be instantiated.
@param name The object name of the MBean. May be null.
@param loaderName The object name of the class loader to be used.
Return:
@return An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n) .getClassName().
Exceptions:
@exception ReflectionException Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
@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 MBeanException The constructor of the MBean has thrown an exception
@exception NotCompliantMBeanException This class is not a JMX compliant MBean
@exception InstanceNotFoundException The specified class loader is not registered in the MBean server.

Specified by:
createMBean from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

createMBeantop

public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException

Instantiates and registers an MBean in the MBean server. The class loader to be used is identified by its object name. An object name is associated to the MBean. If the object name of the loader is not specified, the ClassLoader that loaded the MBean server will be used. If the MBean object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.
Parameters:
@param className The class name of the MBean to be instantiated.
@param name The object name of the MBean. May be null.
@param loaderName The object name of the class loader to be used.
@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:
@return An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n) .getClassName().
Exceptions:
@exception ReflectionException Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
@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 MBeanException The constructor of the MBean has thrown an exception
@exception NotCompliantMBeanException This class is not a JMX compliant MBean
@exception InstanceNotFoundException The specified class loader is not registered in the MBean server.

Specified by:
createMBean from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

createMBeantop

public ObjectInstance createMBean(String className, ObjectName name, Object[] params, String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException

Instantiates and registers an MBean in the MBean server. The MBean server will use its Default Loader Repository to load the class of the MBean. An object name is associated to the MBean. If the object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.
Parameters:
@param className The class name of the MBean to be instantiated.
@param name The object name of the MBean. May be null.
@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:
@return An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n) .getClassName().
Exceptions:
@exception ReflectionException Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
@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 MBeanException The constructor of the MBean has thrown an exception
@exception NotCompliantMBeanException This class is not a JMX compliant MBean

Specified by:
createMBean from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

deserializetop
- @Deprecated
public ObjectInputStream deserialize(String className, ObjectName loaderName, byte[] data) throws InstanceNotFoundException, 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.
Parameters:
@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:
@return The de-serialized object stream.
Exceptions:
@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:
@deprecated Use getClassLoader to obtain the class loader for deserialization.

Related Links:

Google Code Search

Stack Overflow

deserializetop
- @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 found by loading the class className through the Class Loader Repository. The resultant class's class loader is the one to use.
Parameters:
@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:
@return The de-serialized object stream.
Exceptions:
@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:
@deprecated Use javax.management.MBeanServer.getClassLoaderRepository() to obtain the class loader repository and use it to deserialize.

Related Links:

Google Code Search

Stack Overflow

deserializetop
- @Deprecated
public ObjectInputStream deserialize(ObjectName name, byte[] data) throws InstanceNotFoundException, OperationsException
De-serializes a byte array in the context of the class loader of an MBean.
Parameters:
@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:
@return The de-serialized object stream.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not found.
@exception OperationsException Any of the usual Input/Output related exceptions.
Deprecated:
@deprecated Use getClassLoaderFor to obtain the appropriate class loader for deserialization.

Related Links:

Google Code Search

Stack Overflow

getAttributetop

public Object getAttribute(ObjectName name, String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException

Gets the value of a specific attribute of a named MBean. The MBean is identified by its object name.
Parameters:
@param name The object name of the MBean from which the attribute is to be retrieved.
@param attribute A String specifying the name of the attribute to be retrieved.
Return:
@return The value of the retrieved attribute.
Exceptions:
@exception MBeanException Wraps an exception thrown by the MBean's getter.
@exception AttributeNotFoundException The attribute specified is not accessible in the MBean.
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.
@exception ReflectionException Wraps a java.lang.Exception thrown when trying to invoke the setter.

Specified by:
getAttribute from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

getAttributestop

public AttributeList getAttributes(ObjectName name, String[] attributes) throws InstanceNotFoundException, ReflectionException

Enables the values of several attributes of a named MBean. The MBean is identified by its object name.
Parameters:
@param name The object name of the MBean from which the attributes are retrieved.
@param attributes A list of the attributes to be retrieved.
Return:
@return The list of the retrieved attributes.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.
@exception ReflectionException An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.

Specified by:
getAttributes from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

getClassLoadertop

public ClassLoader getClassLoader(ObjectName loaderName) throws InstanceNotFoundException
Return the named ClassLoader.
Parameters:
@param loaderName The ObjectName of the ClassLoader. May be null, in which case the MBean server's own ClassLoader is returned.
Return:
@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 .loadClass(s) is the same as l .loadClass(s) for any string s.
What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.
Exceptions:
@exception InstanceNotFoundException if the named ClassLoader is not found.
Related Links:

Google Code Search

Stack Overflow

getClassLoaderFortop

public ClassLoader getClassLoaderFor(ObjectName mbeanName) throws InstanceNotFoundException
Return the ClassLoader that was used for loading the class of the named MBean.
Parameters:
@param mbeanName The ObjectName of the MBean.
Return:
@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 .loadClass(s) is the same as l .loadClass(s) for any string s.
What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.
Exceptions:
@exception InstanceNotFoundException if the named MBean is not found.
Related Links:

Google Code Search

Stack Overflow

getClassLoaderRepositorytop

public ClassLoaderRepository getClassLoaderRepository()

Return the ClassLoaderRepository for this MBeanServer.
Return:
@return The ClassLoaderRepository for this MBeanServer.

Related Links:

Google Code Search

Stack Overflow

getDefaultDomaintop

public String getDefaultDomain()

Returns the default domain used for naming the MBean. The default domain name is used as the domain part in the ObjectName of MBeans if no domain is specified by the user.
Return:
@return the default domain.

Specified by:
getDefaultDomain from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

getDomainstop

public String[] getDomains()

Returns the list of domains in which any MBean is currently registered. A string is in the returned array if and only if there is at least one MBean registered with an ObjectName whose getDomain() is equal to that string. The order of strings within the returned array is not defined.
Return:
@return the list of domains.

Specified by:
getDomains from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

getMBeanCounttop

public Integer getMBeanCount()

Returns the number of MBeans registered in the MBean server.
Return:
@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.

Specified by:
getMBeanCount from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

getMBeanInfotop

public MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException, ReflectionException

This method discovers the attributes and operations that an MBean exposes for management.
Parameters:
@param name The name of the MBean to analyze
Return:
@return An instance of MBeanInfo allowing the retrieval of all attributes and operations of this MBean.
Exceptions:
@exception InstanceNotFoundException The MBean specified was not found.
@exception IntrospectionException An exception occurred during introspection.
@exception ReflectionException An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean.

Specified by:
getMBeanInfo from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

getObjectInstancetop

public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException

Gets the ObjectInstance for a given MBean registered with the MBean server.
Parameters:
@param name The object name of the MBean.
Return:
@return The ObjectInstance associated with the MBean specified by name. The contained ObjectName is name and the contained class name is getMBeanInfo(name) .getClassName().
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.

Specified by:
getObjectInstance from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

instantiatetop

public Object instantiate(String className) throws ReflectionException, MBeanException

Instantiates an object using the list of all class loaders registered in the MBean server's 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 instantiate(className, (Object[]) null, (String[]) null).
Parameters:
@param className The class name of the object to be instantiated.
Return:
@return The newly instantiated object.
Exceptions:
@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.

Related Links:

Google Code Search

Stack Overflow

instantiatetop

public Object instantiate(String className, ObjectName loaderName) throws ReflectionException, MBeanException, InstanceNotFoundException

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 instantiate(className, loaderName, (Object[]) null, (String[]) null).
Parameters:
@param className The class name of the MBean to be instantiated.
@param loaderName The object name of the class loader to be used.
Return:
@return The newly instantiated object.
Exceptions:
@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.

Related Links:

Google Code Search

Stack Overflow

instantiatetop

public Object instantiate(String className, ObjectName loaderName, Object[] params, String[] signature) throws ReflectionException, MBeanException, InstanceNotFoundException

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.
Parameters:
@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:
@return The newly instantiated object.
Exceptions:
@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.

Related Links:

Google Code Search

Stack Overflow

instantiatetop

public Object instantiate(String className, Object[] params, String[] signature) throws ReflectionException, MBeanException

Instantiates an object using the list of all class loaders registered in the MBean server 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.
Parameters:
@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:
@return The newly instantiated object.
Exceptions:
@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.

Related Links:

Google Code Search

Stack Overflow

invoketop

public Object invoke(ObjectName name, String operationName, Object[] params, String[] signature) throws InstanceNotFoundException, MBeanException, ReflectionException

Invokes an operation on an MBean.
Parameters:
@param name The object name of the MBean on which the method is to be invoked.
@param operationName The name of the operation to be invoked.
@param params An array containing the parameters to be set when the operation is invoked
@param signature An array containing the signature of the operation. The class objects will be loaded using the same class loader as the one used for loading the MBean on which the operation was invoked.
Return:
@return The object returned by the operation, which represents the result of invoking the operation on the MBean specified.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.
@exception MBeanException Wraps an exception thrown by the MBean's invoked method.
@exception ReflectionException Wraps a java.lang.Exception thrown while trying to invoke the method.

Specified by:
invoke from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

isInstanceOftop

public boolean isInstanceOf(ObjectName name, String className) throws InstanceNotFoundException

Returns true if the MBean specified is an instance of the specified class, false otherwise.

If name does not name an MBean, this method throws javax.management.InstanceNotFoundException.

Otherwise, let
X be the MBean named by name,
L be the ClassLoader of X,
N be the class name in X's javax.management.MBeanInfo.

If N equals className, the result is true.

Otherwise, if L successfully loads className and X is an instance of this class, the result is true.
Otherwise, if L successfully loads both N and className, and the second class is assignable from the first, the result is true.

Otherwise, the result is false.
Parameters:
@param name The ObjectName of the MBean.
@param className The name of the class.
Return:
@return true if the MBean specified is an instance of the specified class according to the rules above, false otherwise.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.

Specified by:
isInstanceOf from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

isRegisteredtop

public boolean isRegistered(ObjectName name)

Checks whether an MBean, identified by its object name, is already registered with the MBean server.
Parameters:
@param name The object name of the MBean to be checked.
Return:
@return True if the MBean is already registered in the MBean server, false otherwise.

Specified by:
isRegistered from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

queryMBeanstop

public Set<ObjectInstance> queryMBeans(ObjectName name, QueryExp query)

Gets MBeans controlled by the MBean server. This method allows any of the following to be obtained: All MBeans, a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression, a specific MBean. When the object name is null or no domain and key properties are specified, all objects are to be selected (and filtered if a query is specified). It returns the set of ObjectInstance objects (containing the ObjectName and the Java Class name) for the selected MBeans.
Parameters:
@param name The object name pattern identifying the MBeans to be retrieved. If null or no domain and key properties are specified, all the MBeans registered will be retrieved.
@param query The query expression to be applied for selecting MBeans. If null no query expression will be applied for selecting MBeans.
Return:
@return A set containing the ObjectInstance objects for the selected MBeans. If no MBean satisfies the query an empty list is returned.

Specified by:
queryMBeans from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

queryNamestop

public Set<ObjectName> queryNames(ObjectName name, QueryExp query)

Gets the names of MBeans controlled by the MBean server. This method enables any of the following to be obtained: The names of all MBeans, the names of a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression, a specific MBean name (equivalent to testing whether an MBean is registered). When the object name is null or no domain and key properties are specified, all objects are selected (and filtered if a query is specified). It returns the set of ObjectNames for the MBeans selected.
Parameters:
@param name The object name pattern identifying the MBean names to be retrieved. If null or no domain and key properties are specified, the name of all registered MBeans will be retrieved.
@param query The query expression to be applied for selecting MBeans. If null no query expression will be applied for selecting MBeans.
Return:
@return A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.

Specified by:
queryNames from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

registerMBeantop

public ObjectInstance registerMBean(Object object, ObjectName name) throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException

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 MBeanRegistration interface and returning the name from the preRegister method.
Parameters:
@param object The MBean to be registered as an MBean.
@param name The object name of the MBean. May be null.
Return:
@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 getMBeanInfo(n) .getClassName().
Exceptions:
@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.

Related Links:

Google Code Search

Stack Overflow

removeNotificationListenertop

public void removeNotificationListener(ObjectName name, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException

Removes a listener from a registered MBean.

If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.
Parameters:
@param name The name of the MBean on which the listener should be removed.
@param listener The listener to be removed.
Exceptions:
@exception InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
@exception ListenerNotFoundException The listener is not registered in the MBean.

Specified by:
removeNotificationListener from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

removeNotificationListenertop

public void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException

Removes a listener from a registered MBean.

The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.
Parameters:
@param name The name of the MBean on which the listener should be removed.
@param listener The listener to be removed.
@param filter The filter that was specified when the listener was added.
@param handback The handback that was specified when the listener was added.
Exceptions:
@exception InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
@exception ListenerNotFoundException The listener is not registered in the MBean, or it is not registered with the given filter and handback.

Specified by:
removeNotificationListener from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

removeNotificationListenertop

public void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException

Removes a listener from a registered MBean.
If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.
Parameters:
@param name The name of the MBean on which the listener should be removed.
@param listener The object name of the listener to be removed.
Exceptions:
@exception InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
@exception ListenerNotFoundException The listener is not registered in the MBean.

Specified by:
removeNotificationListener from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

removeNotificationListenertop

public void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException

Removes a listener from a registered MBean.

The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.
Parameters:
@param name The name of the MBean on which the listener should be removed.
@param listener The object name of the listener to be removed.
@param filter The filter that was specified when the listener was added.
@param handback The handback that was specified when the listener was added.
Exceptions:
@exception InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
@exception ListenerNotFoundException The listener is not registered in the MBean, or it is not registered with the given filter and handback.

Specified by:
removeNotificationListener from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

setAttributetop

public void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException

Sets the value of a specific attribute of a named MBean. The MBean is identified by its object name.
Parameters:
@param name The name of the MBean within which the attribute is to be set.
@param attribute The identification of the attribute to be set and the value it is to be set to.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.
@exception AttributeNotFoundException The attribute specified is not accessible in the MBean.
@exception InvalidAttributeValueException The value specified for the attribute is not valid.
@exception MBeanException Wraps an exception thrown by the MBean's setter.
@exception ReflectionException Wraps a java.lang.Exception thrown when trying to invoke the setter.

Specified by:
setAttribute from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

setAttributestop

public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException, ReflectionException

Sets the values of several attributes of a named MBean. The MBean is identified by its object name.
Parameters:
@param name The object name of the MBean within which the attributes are to be set.
@param attributes A list of attributes: The identification of the attributes to be set and the values they are to be set to.
Return:
@return The list of attributes that were set, with their new values.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.
@exception ReflectionException An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.

Specified by:
setAttributes from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

unregisterMBeantop

public void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException

Unregisters an MBean from the MBean server. The MBean is identified by its object name. Once the method has been invoked, the MBean may no longer be accessed by its object name.
Parameters:
@param name The object name of the MBean to be unregistered.
Exceptions:
@exception InstanceNotFoundException The MBean specified is not registered in the MBean server.
@exception MBeanRegistrationException The preDeregister ((MBeanRegistration interface) method of the MBean has thrown an exception.

Specified by:
unregisterMBean from MBeanServerConnection

Related Links:

Google Code Search

Stack Overflow

rootjavaj2se1.6javax.managementMBeanServer