| javax.management.MBeanServerConnection
| MBeanServerConnection | | public interface MBeanServerConnection (Code) | | 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.
author:
Young Yang |
| Method Summary | |
| public void | addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)
Adds a listener to a registered MBean.
A notification emitted by an MBean will be forwarded by the
MBeanServer to the listener. | | public void | addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)
Adds a listener to a registered MBean.
A notification emitted by an MBean will be forwarded by the
MBeanServer to the listener. | | public ObjectInstance | createMBean(String className, ObjectName name)
Instantiates and registers an MBean in the MBean server. | | public ObjectInstance | createMBean(String className, ObjectName name, ObjectName loaderName)
Instantiates and registers an MBean in the MBean server. | | public ObjectInstance | createMBean(String className, ObjectName name, Object params, String signature)
Instantiates and registers an MBean in the MBean server. | | public ObjectInstance | createMBean(String className, ObjectName name, ObjectName loaderName, Object params, String signature)
Instantiates and registers an MBean in the MBean server. | | public Object | getAttribute(ObjectName name, String attribute)
Gets the value of a specific attribute of a named MBean. | | public AttributeList | getAttributes(ObjectName name, String[] attributes)
Enables the values of several attributes of a named MBean. | | public String | getDefaultDomain()
Returns the default domain used for naming the MBean. | | public String[] | getDomains()
Returns the list of domains in which any MBean is currently
registered. | | public Integer | getMBeanCount()
Returns the number of MBeans registered in the MBean server. | | public MBeanInfo | getMBeanInfo(ObjectName name)
This method discovers the attributes and operations that an
MBean exposes for management. | | public ObjectInstance | getObjectInstance(ObjectName name)
Gets the ObjectInstance for a given MBean
registered with the MBean server.
Parameters:
name - The object name of the MBean. | | public Object | invoke(ObjectName name, String operationName, Object params, String signature)
Invokes an operation on an MBean.
Parameters:
name - The object name of the MBean on which the method isto be invoked.
Parameters:
operationName - The name of the operation to be invoked.
Parameters:
params - An array containing the parameters to be set whenthe operation is invoked
Parameters:
signature - An array containing the signature of theoperation. | | public boolean | isInstanceOf(ObjectName name, 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
InstanceNotFoundException .
Otherwise, let
X be the MBean named by name,
L be the ClassLoader of X,
N be the class name in X's
MBeanInfo .
If N equals className, 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:
name - The ObjectName of the MBean.
Parameters:
className - The name of the class. | | public boolean | isRegistered(ObjectName name)
Checks whether an MBean, identified by its object name, is
already registered with the MBean server.
Parameters:
name - The object name of the MBean to be checked. | | public Set | queryMBeans(ObjectName name, QueryExp query)
Gets MBeans controlled by the MBean server. | | public Set | queryNames(ObjectName name, QueryExp query)
Gets the names of MBeans controlled by the MBean server. | | public void | removeNotificationListener(ObjectName name, ObjectName listener)
Removes a listener from a registered MBean. | | public void | removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, 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. | | public void | removeNotificationListener(ObjectName name, 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. | | public void | removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, 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. | | public void | setAttribute(ObjectName name, Attribute attribute)
Sets the value of a specific attribute of a named MBean. | | public AttributeList | setAttributes(ObjectName name, AttributeList attributes)
Sets the values of several attributes of a named MBean. | | public void | unregisterMBean(ObjectName name)
Unregisters an MBean from the MBean server. |
| addNotificationListener | | public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, IOException(Code) | | 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:
name - The name of the MBean on which the listener shouldbe added.
Parameters:
listener - The listener object which will handle thenotifications emitted by the registered MBean.
Parameters:
filter - The filter object. If filter is null, nofiltering will be performed before handling notifications.
Parameters:
handback - The context to be sent to the listener when anotification is emitted.
exception:
InstanceNotFoundException - The MBean name provideddoes not match any of the registered MBeans.
exception:
IOException - A communication problem occurred whentalking to the MBean server.
See Also: MBeanServerConnection.removeNotificationListener(ObjectName,NotificationListener)
See Also: MBeanServerConnection.removeNotificationListener(ObjectName,NotificationListener,NotificationFilter,Object) |
| addNotificationListener | | public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, IOException(Code) | | 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:
name - The name of the MBean on which the listener shouldbe added.
Parameters:
listener - The object name of the listener which willhandle the notifications emitted by the registered MBean.
Parameters:
filter - The filter object. If filter is null, nofiltering will be performed before handling notifications.
Parameters:
handback - The context to be sent to the listener when anotification is emitted.
exception:
InstanceNotFoundException - The MBean name of thenotification listener or of the notification broadcaster doesnot match any of the registered MBeans.
exception:
RuntimeOperationsException - Wraps an IllegalArgumentException. The MBean named bylistener exists but does not implement the NotificationListener interface.
exception:
IOException - A communication problem occurred whentalking to the MBean server.
See Also: MBeanServerConnection.removeNotificationListener(ObjectName,ObjectName)
See Also: MBeanServerConnection.removeNotificationListener(ObjectName,ObjectName,NotificationFilter,Object) |
| createMBean | | public ObjectInstance createMBean(String className, ObjectName name) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, IOException(Code) | | Instantiates and registers an MBean in the MBean server. The
MBean server will use its
javax.management.loading.ClassLoaderRepository Default LoaderRepository 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
javax.management.MBeanRegistration MBeanRegistration interface
and returning the name from the
MBeanRegistration.preRegister preRegister method.
This method is equivalent to
MBeanServerConnection.createMBean(String,ObjectName,Object[],String[])createMBean(className, name, (Object[]) null, (String[])null) .
Parameters:
className - The class name of the MBean to be instantiated.
Parameters:
name - The object name of the MBean. May be null. An ObjectInstance, containing theObjectName and the Java class name of the newlyinstantiated MBean. If the contained ObjectNameis n, the contained Java class name isMBeanServerConnection.getMBeanInfo getMBeanInfo(n).getClassName().
exception:
ReflectionException - Wraps ajava.lang.ClassNotFoundException or ajava.lang.Exception
exception:
InstanceAlreadyExistsException - The MBean is alreadyunder the control of the MBean server.
exception:
MBeanRegistrationException - ThepreRegister (MBeanRegistrationinterface) method of the MBean has thrown an exception. TheMBean will not be registered.
exception:
MBeanException - The constructor of the MBean hasthrown an exception
exception:
NotCompliantMBeanException - This class is not a JMXcompliant MBean
exception:
RuntimeOperationsException - Wraps ajava.lang.IllegalArgumentException: The classNamepassed in parameter is null, the ObjectName passedin parameter contains a pattern or no ObjectNameis specified for the MBean.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| createMBean | | public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException(Code) | | 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
javax.management.MBeanRegistration MBeanRegistration interface
and returning the name from the
MBeanRegistration.preRegister preRegister method.
This method is equivalent to
MBeanServerConnection.createMBean(String,ObjectName,ObjectName,Object[],String[])createMBean(className, name, loaderName, (Object[]) null,(String[]) null) .
Parameters:
className - The class name of the MBean to be instantiated.
Parameters:
name - The object name of the MBean. May be null.
Parameters:
loaderName - The object name of the class loader to be used. An ObjectInstance, containing theObjectName and the Java class name of the newlyinstantiated MBean. If the contained ObjectNameis n, the contained Java class name isMBeanServerConnection.getMBeanInfo getMBeanInfo(n).getClassName().
exception:
ReflectionException - Wraps ajava.lang.ClassNotFoundException or ajava.lang.Exception that occurred when trying toinvoke the MBean's constructor.
exception:
InstanceAlreadyExistsException - The MBean is alreadyunder the control of the MBean server.
exception:
MBeanRegistrationException - ThepreRegister (MBeanRegistrationinterface) method of the MBean has thrown an exception. TheMBean will not be registered.
exception:
MBeanException - The constructor of the MBean hasthrown an exception
exception:
NotCompliantMBeanException - This class is not a JMXcompliant MBean
exception:
InstanceNotFoundException - The specified class loaderis not registered in the MBean server.
exception:
RuntimeOperationsException - Wraps ajava.lang.IllegalArgumentException: The classNamepassed in parameter is null, the ObjectName passedin parameter contains a pattern or no ObjectNameis specified for the MBean.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| createMBean | | public ObjectInstance createMBean(String className, ObjectName name, Object params, String signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, IOException(Code) | | Instantiates and registers an MBean in the MBean server. The
MBean server will use its
javax.management.loading.ClassLoaderRepository Default LoaderRepository 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
javax.management.MBeanRegistration MBeanRegistration interface
and returning the name from the
MBeanRegistration.preRegister preRegister method.
Parameters:
className - The class name of the MBean to be instantiated.
Parameters:
name - The object name of the MBean. May be null.
Parameters:
params - An array containing the parameters of theconstructor to be invoked.
Parameters:
signature - An array containing the signature of theconstructor to be invoked. An ObjectInstance, containing theObjectName and the Java class name of the newlyinstantiated MBean. If the contained ObjectNameis n, the contained Java class name isMBeanServerConnection.getMBeanInfo getMBeanInfo(n).getClassName().
exception:
ReflectionException - Wraps ajava.lang.ClassNotFoundException or ajava.lang.Exception that occurred when trying toinvoke the MBean's constructor.
exception:
InstanceAlreadyExistsException - The MBean is alreadyunder the control of the MBean server.
exception:
MBeanRegistrationException - ThepreRegister (MBeanRegistrationinterface) method of the MBean has thrown an exception. TheMBean will not be registered.
exception:
MBeanException - The constructor of the MBean hasthrown an exception
exception:
NotCompliantMBeanException - This class is not a JMXcompliant MBean
exception:
RuntimeOperationsException - Wraps ajava.lang.IllegalArgumentException: The classNamepassed in parameter is null, the ObjectName passedin parameter contains a pattern or no ObjectNameis specified for the MBean.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| createMBean | | public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object params, String signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException(Code) | | 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
javax.management.MBeanRegistration MBeanRegistration interface and returning the name from the
MBeanRegistration.preRegister preRegister method.
Parameters:
className - The class name of the MBean to be instantiated.
Parameters:
name - The object name of the MBean. May be null.
Parameters:
params - An array containing the parameters of theconstructor to be invoked.
Parameters:
signature - An array containing the signature of theconstructor to be invoked.
Parameters:
loaderName - The object name of the class loader to be used. An ObjectInstance, containing theObjectName and the Java class name of the newlyinstantiated MBean. If the contained ObjectNameis n, the contained Java class name isMBeanServerConnection.getMBeanInfo getMBeanInfo(n).getClassName().
exception:
ReflectionException - Wraps ajava.lang.ClassNotFoundException or ajava.lang.Exception that occurred when trying toinvoke the MBean's constructor.
exception:
InstanceAlreadyExistsException - The MBean is alreadyunder the control of the MBean server.
exception:
MBeanRegistrationException - ThepreRegister (MBeanRegistrationinterface) method of the MBean has thrown an exception. TheMBean will not be registered.
exception:
MBeanException - The constructor of the MBean hasthrown an exception
exception:
NotCompliantMBeanException - This class is not a JMXcompliant MBean
exception:
InstanceNotFoundException - The specified class loaderis not registered in the MBean server.
exception:
RuntimeOperationsException - Wraps ajava.lang.IllegalArgumentException: The classNamepassed in parameter is null, the ObjectName passedin parameter contains a pattern or no ObjectNameis specified for the MBean.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| getDefaultDomain | | public String getDefaultDomain() throws IOException(Code) | | 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.
the default domain.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| getDomains | | public String[] getDomains() throws IOException(Code) | | 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
ObjectName.getDomain getDomain() is equal to that
string. The order of strings within the returned array is
not defined.
the list of domains.
exception:
IOException - A communication problem occurred whentalking to the MBean server.
since:
JMX 1.2 |
| getMBeanCount | | public Integer getMBeanCount() throws IOException(Code) | | Returns the number of MBeans registered in the MBean server.
the number of MBeans registered.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| invoke | | public Object invoke(ObjectName name, String operationName, Object params, String signature) throws InstanceNotFoundException, MBeanException, ReflectionException, IOException(Code) | | Invokes an operation on an MBean.
Parameters:
name - The object name of the MBean on which the method isto be invoked.
Parameters:
operationName - The name of the operation to be invoked.
Parameters:
params - An array containing the parameters to be set whenthe operation is invoked
Parameters:
signature - An array containing the signature of theoperation. The class objects will be loaded using the sameclass loader as the one used for loading the MBean on which theoperation was invoked. The object returned by the operation, which representsthe result ofinvoking the operation on the MBean specified.
exception:
InstanceNotFoundException - The MBean specified is notregistered in the MBean server.
exception:
MBeanException - Wraps an exception thrown by theMBean's invoked method.
exception:
ReflectionException - Wraps ajava.lang.Exception thrown while trying to invokethe method.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| isInstanceOf | | public boolean isInstanceOf(ObjectName name, String className) throws InstanceNotFoundException, IOException(Code) | | 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
InstanceNotFoundException .
Otherwise, let
X be the MBean named by name,
L be the ClassLoader of X,
N be the class name in X's
MBeanInfo .
If N equals className, 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:
name - The ObjectName of the MBean.
Parameters:
className - The name of the class. true if the MBean specified is an instance of thespecified class according to the rules above, false otherwise.
exception:
InstanceNotFoundException - The MBean specified is notregistered in the MBean server.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| isRegistered | | public boolean isRegistered(ObjectName name) throws IOException(Code) | | Checks whether an MBean, identified by its object name, is
already registered with the MBean server.
Parameters:
name - The object name of the MBean to be checked. True if the MBean is already registered in the MBeanserver, false otherwise.
exception:
RuntimeOperationsException - Wraps ajava.lang.IllegalArgumentException: The objectname in parameter is null.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| queryMBeans | | public Set queryMBeans(ObjectName name, QueryExp query) throws IOException(Code) | | 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:
name - The object name pattern identifying the MBeans tobe retrieved. If null or no domain and key properties arespecified, all the MBeans registered will be retrieved.
Parameters:
query - The query expression to be applied for selectingMBeans. If null no query expression will be applied forselecting MBeans. A set containing the ObjectInstanceobjects for the selected MBeans. If no MBean satisfies thequery an empty list is returned.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| queryNames | | public Set queryNames(ObjectName name, QueryExp query) throws IOException(Code) | | 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:
name - The object name pattern identifying the MBean namesto be retrieved. If null oror no domain and key properties arespecified, the name of all registered MBeans will be retrieved.
Parameters:
query - The query expression to be applied for selectingMBeans. If null no query expression will be applied forselecting MBeans. A set containing the ObjectNames for the MBeansselected. If no MBean satisfies the query, an empty list isreturned.
exception:
IOException - A communication problem occurred whentalking to the MBean server. |
| removeNotificationListener | | public void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException, IOException(Code) | | 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:
name - The name of the MBean on which the listener shouldbe removed.
Parameters:
listener - A listener that was previously added to thisMBean.
Parameters:
filter - The filter that was specified when the listenerwas added.
Parameters:
handback - The handback that was specified when thelistener was added.
exception:
InstanceNotFoundException - The MBean name provideddoes not match any of the registered MBeans.
exception:
ListenerNotFoundException - The listener is notregistered in the MBean, or it is not registered with the givenfilter and handback.
exception:
IOException - A communication problem occurred whentalking to the MBean server.
See Also: MBeanServerConnection.addNotificationListener(ObjectName,ObjectName,NotificationFilter,Object)
since:
JMX 1.2 |
| removeNotificationListener | | public void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException, IOException(Code) | | 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:
name - The name of the MBean on which the listener shouldbe removed.
Parameters:
listener - A listener that was previously added to thisMBean.
Parameters:
filter - The filter that was specified when the listenerwas added.
Parameters:
handback - The handback that was specified when thelistener was added.
exception:
InstanceNotFoundException - The MBean name provideddoes not match any of the registered MBeans.
exception:
ListenerNotFoundException - The listener is notregistered in the MBean, or it is not registered with the givenfilter and handback.
exception:
IOException - A communication problem occurred whentalking to the MBean server.
See Also: MBeanServerConnection.addNotificationListener(ObjectName,NotificationListener,NotificationFilter,Object)
since:
JMX 1.2 |
|
|