Interface MBeanServerConnection

All Known Subinterfaces:

MBeanServer, MBeanServerForwarder

public interface MBeanServerConnection

This interface represents a way to talk to an MBean server, whether local or remote. The MBeanServer interface, representing a local MBean server, extends this interface.

Since:

1.5

Method Summary

Modifier and Type	Method	Description
void	addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)	Adds a listener to a registered MBean.
void	addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)	Adds a listener to a registered MBean.
ObjectInstance	createMBean(String className, ObjectName name)	Instantiates and registers an MBean in the MBean server.
ObjectInstance	createMBean(String className, ObjectName name, Object[] params, String[] signature)	Instantiates and registers an MBean in the MBean server.
ObjectInstance	createMBean(String className, ObjectName name, ObjectName loaderName)	Instantiates and registers an MBean in the MBean server.
ObjectInstance	createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature)	Instantiates and registers an MBean in the MBean server.
Object	getAttribute(ObjectName name, String attribute)	Gets the value of a specific attribute of a named MBean.
AttributeList	getAttributes(ObjectName name, String[] attributes)	Retrieves the values of several attributes of a named MBean.
String	getDefaultDomain()	Returns the default domain used for naming the MBean.
String[]	getDomains()	Returns the list of domains in which any MBean is currently registered.
Integer	getMBeanCount()	Returns the number of MBeans registered in the MBean server.
MBeanInfo	getMBeanInfo(ObjectName name)	This method discovers the attributes and operations that an MBean exposes for management.
ObjectInstance	getObjectInstance(ObjectName name)	Gets the ObjectInstance for a given MBean registered with the MBean server.
Object	invoke(ObjectName name, String operationName, Object[] params, String[] signature)	Invokes an operation on an MBean.
boolean	isInstanceOf(ObjectName name, String className)	Returns true if the MBean specified is an instance of the specified class, false otherwise.
boolean	isRegistered(ObjectName name)	Checks whether an MBean, identified by its object name, is already registered with the MBean server.
Set<ObjectInstance>	queryMBeans(ObjectName name, QueryExp query)	Gets MBeans controlled by the MBean server.
Set<ObjectName>	queryNames(ObjectName name, QueryExp query)	Gets the names of MBeans controlled by the MBean server.
void	removeNotificationListener(ObjectName name, NotificationListener listener)	Removes a listener from a registered MBean.
void	removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)	Removes a listener from a registered MBean.
void	removeNotificationListener(ObjectName name, ObjectName listener)	Removes a listener from a registered MBean.
void	removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)	Removes a listener from a registered MBean.
void	setAttribute(ObjectName name, Attribute attribute)	Sets the value of a specific attribute of a named MBean.
AttributeList	setAttributes(ObjectName name, AttributeList attributes)	Sets the values of several attributes of a named MBean.
void	unregisterMBean(ObjectName name)	Unregisters an MBean from the MBean server.

Method Details

createMBean

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

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 with 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:

className - The class name of the MBean to be instantiated.

name - The object name of the MBean. May be null.

Returns:

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().

Throws:

ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.

InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

RuntimeMBeanException - If the MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.

RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.

MBeanException - The constructor of the MBean has thrown an exception

NotCompliantMBeanException - This class is not a JMX compliant MBean

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.

IOException - A communication problem occurred when talking to the MBean server.

See Also:

• MBeanRegistration

createMBean

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

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 with 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:

className - The class name of the MBean to be instantiated.

name - The object name of the MBean. May be null.

loaderName - The object name of the class loader to be used.

Returns:

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().

Throws:

ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.

InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

RuntimeMBeanException - If the MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.

RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.

MBeanException - The constructor of the MBean has thrown an exception

NotCompliantMBeanException - This class is not a JMX compliant MBean

InstanceNotFoundException - The specified class loader is not registered in the MBean server.

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.

IOException - A communication problem occurred when talking to the MBean server.

See Also:

• MBeanRegistration

createMBean

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

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 with 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:

className - The class name of the MBean to be instantiated.

name - The object name of the MBean. May be null.

params - An array containing the parameters of the constructor to be invoked.

signature - An array containing the signature of the constructor to be invoked.

Returns:

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().

Throws:

ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.

InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

RuntimeMBeanException - If the MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.

RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.

MBeanException - The constructor of the MBean has thrown an exception

NotCompliantMBeanException - This class is not a JMX compliant MBean

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.

IOException - A communication problem occurred when talking to the MBean server.

See Also:

• MBeanRegistration

createMBean

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

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 with 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:

className - The class name of the MBean to be instantiated.

name - The object name of the MBean. May be null.

loaderName - The object name of the class loader to be used.

params - An array containing the parameters of the constructor to be invoked.

signature - An array containing the signature of the constructor to be invoked.

Returns:

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().

Throws:

ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.

InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

RuntimeMBeanException - The MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.

RuntimeErrorException - If the postRegister method (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.

MBeanException - The constructor of the MBean has thrown an exception

NotCompliantMBeanException - This class is not a JMX compliant MBean

InstanceNotFoundException - The specified class loader is not registered in the MBean server.

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.

IOException - A communication problem occurred when talking to the MBean server.

See Also:

• MBeanRegistration

unregisterMBean

void unregisterMBean(ObjectName name)
              throws InstanceNotFoundException,
MBeanRegistrationException,
IOException

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:

name - The object name of the MBean to be unregistered.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.