FileDocCategorySizeDatePackage
MBeanServerConnection.javaAPI DocJava SE 6 API36040Tue Jun 10 00:26:12 BST 2008javax.management

MBeanServerConnection

public interface MBeanServerConnection
This interface represents a way to talk to an MBean server, whether local or remote. The {@link MBeanServer} interface, representing a local MBean server, extends this interface.
since
1.5
since.unbundled
JMX 1.2

Fields Summary
Constructors Summary
Methods Summary
public voidaddNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)

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.

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.
exception
InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#removeNotificationListener(ObjectName, NotificationListener)
see
#removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)

public voidaddNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener, javax.management.NotificationFilter filter, java.lang.Object handback)

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.

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.
exception
InstanceNotFoundException The MBean name of the notification listener or of the notification broadcaster does not match any of the registered MBeans.
exception
RuntimeOperationsException Wraps an {@link IllegalArgumentException}. The MBean named by listener exists but does not implement the {@link NotificationListener} interface.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#removeNotificationListener(ObjectName, ObjectName)
see
#removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)

public javax.management.ObjectInstancecreateMBean(java.lang.String className, javax.management.ObjectName name)

Instantiates and registers an MBean in the MBean server. The MBean server will use its {@link javax.management.loading.ClassLoaderRepository 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 {@link javax.management.MBeanRegistration MBeanRegistration} interface and returning the name from the {@link MBeanRegistration#preRegister preRegister} method.

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

param
className The class name of the MBean to be instantiated.
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 instantiated MBean. If the contained ObjectName is n, the contained Java class name is {@link #getMBeanInfo getMBeanInfo(n)}.getClassName().
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
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.
exception
IOException A communication problem occurred when talking to the MBean server.

public javax.management.ObjectInstancecreateMBean(java.lang.String className, javax.management.ObjectName name, javax.management.ObjectName loaderName)

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 {@link javax.management.MBeanRegistration MBeanRegistration} interface and returning the name from the {@link MBeanRegistration#preRegister preRegister} method.

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

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
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 {@link #getMBeanInfo getMBeanInfo(n)}.getClassName().
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.
exception
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.
exception
IOException A communication problem occurred when talking to the MBean server.

public javax.management.ObjectInstancecreateMBean(java.lang.String className, javax.management.ObjectName name, java.lang.Object[] params, java.lang.String[] signature)
Instantiates and registers an MBean in the MBean server. The MBean server will use its {@link javax.management.loading.ClassLoaderRepository 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 {@link javax.management.MBeanRegistration MBeanRegistration} interface and returning the name from the {@link MBeanRegistration#preRegister preRegister} method.

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
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 {@link #getMBeanInfo getMBeanInfo(n)}.getClassName().
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
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.
exception
IOException A communication problem occurred when talking to the MBean server.

public javax.management.ObjectInstancecreateMBean(java.lang.String className, javax.management.ObjectName name, javax.management.ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature)
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 {@link javax.management.MBeanRegistration MBeanRegistration} interface and returning the name from the {@link MBeanRegistration#preRegister preRegister} method.

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.
param
loaderName The object name of the class loader to be used.
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 {@link #getMBeanInfo getMBeanInfo(n)}.getClassName().
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.
exception
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.
exception
IOException A communication problem occurred when talking to the MBean server.

public java.lang.ObjectgetAttribute(javax.management.ObjectName name, java.lang.String attribute)
Gets the value of a specific attribute of a named MBean. The MBean is identified by its object name.

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
The value of the retrieved attribute.
exception
AttributeNotFoundException The attribute specified is not accessible in the MBean.
exception
MBeanException Wraps an exception thrown by the MBean's getter.
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.
exception
RuntimeOperationsException Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#setAttribute

public javax.management.AttributeListgetAttributes(javax.management.ObjectName name, java.lang.String[] attributes)
Enables the values of several attributes of a named MBean. The MBean is identified by its object name.

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
The list of the retrieved attributes.
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.
exception
RuntimeOperationsException Wrap a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#setAttributes

public java.lang.StringgetDefaultDomain()
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
the default domain.
exception
IOException A communication problem occurred when talking to the MBean server.

public java.lang.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 {@link ObjectName#getDomain() getDomain()} is equal to that string. The order of strings within the returned array is not defined.

return
the list of domains.
exception
IOException A communication problem occurred when talking to the MBean server.
since.unbundled
JMX 1.2

public java.lang.IntegergetMBeanCount()
Returns the number of MBeans registered in the MBean server.

return
the number of MBeans registered.
exception
IOException A communication problem occurred when talking to the MBean server.

public javax.management.MBeanInfogetMBeanInfo(javax.management.ObjectName name)
This method discovers the attributes and operations that an MBean exposes for management.

param
name The name of the MBean to analyze
return
An instance of MBeanInfo allowing the retrieval of all attributes and operations of this MBean.
exception
IntrospectionException An exception occurred during introspection.
exception
InstanceNotFoundException The MBean specified was not found.
exception
ReflectionException An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean.
exception
IOException A communication problem occurred when talking to the MBean server.

public javax.management.ObjectInstancegetObjectInstance(javax.management.ObjectName name)
Gets the ObjectInstance for a given MBean registered with the MBean server.

param
name The object name of the MBean.
return
The ObjectInstance associated with the MBean specified by name. The contained ObjectName is name and the contained class name is {@link #getMBeanInfo getMBeanInfo(name)}.getClassName().
exception
InstanceNotFoundException The MBean specified is not registered in the MBean server.
exception
IOException A communication problem occurred when talking to the MBean server.

public java.lang.Objectinvoke(javax.management.ObjectName name, java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature)
Invokes an operation on an MBean.

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
The object returned by the operation, which represents the result of invoking the operation on the MBean specified.
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.
exception
IOException A communication problem occurred when talking to the MBean server.

public booleanisInstanceOf(javax.management.ObjectName name, java.lang.String className)

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 {@link InstanceNotFoundException}.

Otherwise, let
X be the MBean named by name,
L be the ClassLoader of X,
N be the class name in X's {@link 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.

param
name The ObjectName of the MBean.
param
className The name of the class.
return
true if the MBean specified is an instance of the specified class according to the rules above, false otherwise.
exception
InstanceNotFoundException The MBean specified is not registered in the MBean server.
exception
IOException A communication problem occurred when talking to the MBean server.
see
Class#isInstance

public booleanisRegistered(javax.management.ObjectName name)
Checks whether an MBean, identified by its object name, is already registered with the MBean server.

param
name The object name of the MBean to be checked.
return
True if the MBean is already registered in the MBean server, false otherwise.
exception
RuntimeOperationsException Wraps a java.lang.IllegalArgumentException: The object name in parameter is null.
exception
IOException A communication problem occurred when talking to the MBean server.

public java.util.SetqueryMBeans(javax.management.ObjectName name, javax.management.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.

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
A set containing the ObjectInstance objects for the selected MBeans. If no MBean satisfies the query an empty list is returned.
exception
IOException A communication problem occurred when talking to the MBean server.

public java.util.SetqueryNames(javax.management.ObjectName name, javax.management.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.

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
A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.
exception
IOException A communication problem occurred when talking to the MBean server.

public voidremoveNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener)
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.

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.
exception
InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
exception
ListenerNotFoundException The listener is not registered in the MBean.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)

public voidremoveNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener, javax.management.NotificationFilter filter, java.lang.Object handback)

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.

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.
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.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)
since.unbundled
JMX 1.2

public voidremoveNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener)

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.

param
name The name of the MBean on which the listener should be removed.
param
listener The listener to be removed.
exception
InstanceNotFoundException The MBean name provided does not match any of the registered MBeans.
exception
ListenerNotFoundException The listener is not registered in the MBean.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)

public voidremoveNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)

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.

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.
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.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)
since.unbundled
JMX 1.2

public voidsetAttribute(javax.management.ObjectName name, javax.management.Attribute attribute)
Sets the value of a specific attribute of a named MBean. The MBean is identified by its object name.

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.
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.
exception
RuntimeOperationsException Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#getAttribute

public javax.management.AttributeListsetAttributes(javax.management.ObjectName name, javax.management.AttributeList attributes)
Sets the values of several attributes of a named MBean. The MBean is identified by its object name.

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
The list of attributes that were set, with their new values.
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.
exception
RuntimeOperationsException Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.
exception
IOException A communication problem occurred when talking to the MBean server.
see
#getAttributes

public voidunregisterMBean(javax.management.ObjectName name)
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.

param
name The object name of the MBean to be unregistered.
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.
exception
RuntimeOperationsException Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the MBean you are when trying to unregister is the {@link javax.management.MBeanServerDelegate MBeanServerDelegate} MBean.
exception
IOException A communication problem occurred when talking to the MBean server.