|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 an
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
.
Method Summary | |
void |
addNotificationListener(ObjectName name,
NotificationListener listener,
NotificationFilter filter,
java.lang.Object handback)
Enables a couple (listener,handback) for a registered MBean to be added. |
void |
addNotificationListener(ObjectName name,
ObjectName listener,
NotificationFilter filter,
java.lang.Object handback)
Enables a couple (listener,handback) for a registered MBean to be added. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name,
ObjectName loaderName)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name,
ObjectName loaderName,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates and registers an MBean in the MBean server. |
java.io.ObjectInputStream |
deserialize(ObjectName name,
byte[] data)
De-serializes a byte array in the context of the class loader of an MBean. |
java.io.ObjectInputStream |
deserialize(java.lang.String className,
byte[] data)
De-serializes a byte array in the context of a given MBean class loader. |
java.io.ObjectInputStream |
deserialize(java.lang.String className,
ObjectName loaderName,
byte[] data)
De-serializes a byte array in the context of a given MBean class loader. |
java.lang.Object |
getAttribute(ObjectName name,
java.lang.String attribute)
Gets the value of a specific attribute of a named MBean. |
AttributeList |
getAttributes(ObjectName name,
java.lang.String[] attributes)
Enables the values of several attributes of a named MBean. |
java.lang.String |
getDefaultDomain()
Returns the default domain used for naming the MBean. |
java.lang.Integer |
getMBeanCount()
Returns the number of MBeans controlled by the MBeanServer. |
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. |
java.lang.Object |
instantiate(java.lang.String className)
Instantiates an object using the list of all class loaders registered in the MBean server ( Default Loader Repository ). |
java.lang.Object |
instantiate(java.lang.String className,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates an object using the list of all class loaders registered in the MBean server ( Default Loader Repository ). |
java.lang.Object |
instantiate(java.lang.String className,
ObjectName loaderName)
Instantiates an object using the class Loader specified by its ObjectName . |
java.lang.Object |
instantiate(java.lang.String className,
ObjectName loaderName,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates an object. |
java.lang.Object |
invoke(ObjectName name,
java.lang.String actionName,
java.lang.Object[] params,
java.lang.String[] signature)
Invokes an operation on an MBean. |
boolean |
isInstanceOf(ObjectName name,
java.lang.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. |
java.util.Set |
queryMBeans(ObjectName name,
QueryExp query)
Gets MBeans controlled by the MBean server. |
java.util.Set |
queryNames(ObjectName name,
QueryExp query)
Gets the names of MBeans controlled by the MBean server. |
ObjectInstance |
registerMBean(java.lang.Object object,
ObjectName name)
Registers a pre-existing object as an MBean with the MBean server. |
void |
removeNotificationListener(ObjectName name,
NotificationListener listener)
Enables to remove a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName name,
ObjectName listener)
Enables to remove 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)
De-registers an MBean from the MBean server. |
Method Detail |
public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException
name
- The name of the MBean on which the listener should be added.listener
- The listener object which will handles notifications
emitted by the registered MBean.filter
- The filter object. If not specified, no filtering will be
performed before handling notifications.handback
- The context to be sent to the listener when a
notification is emitted.InstanceNotFoundException
- The MBean name
doesn't correspond to a registered MBean.public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException
name
- The name of the MBean on which the listener should be added.listener
- The listener name which will handles notifications
emitted by the registered MBean.filter
- The filter object. If not specified, no filtering will be
performed before handling notifications.handback
- The context to be sent to the listener when a
notification is emitted.InstanceNotFoundException
- The MBean name
doesn't correspond to a registered MBean.public ObjectInstance createMBean(java.lang.String className, ObjectName name) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
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 can automatically
provide its own name by implementing the
MBeanRegistration
interface.
The call returns an ObjectInstance
object representing
the newly created MBean.className
- The class name of the MBean to be instantiated.name
- The object name of the MBean. May be null.ObjectInstance
, containing the
ObjectName
and the Java class name of
the newly instantiated MBean.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.MBeanException
- The constructor of the MBean has thrown an exceptionNotCompliantMBeanException
- This class is not a JMX compliant MBeanRuntimeOperationsException
- 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.public ObjectInstance createMBean(java.lang.String className, ObjectName name, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
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 can automatically provide its own name by implementing
the MBeanRegistration
interface. The call returns an ObjectInstance
object
representing the newly created MBean.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 constructor to be invoked.signature
- An array containing the signature of constructor to be invoked.ObjectInstance
, containing the
ObjectName
and the Java class name of
the newly instantiated MBean.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.MBeanException
- The constructor of the MBean has thrown an 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.public ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException
MBeanRegistration
interface. The call returns an ObjectInstance
object
representing the newly created MBean.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.ObjectInstance
, containing the
ObjectName
and the Java class name of
the newly instantiated MBean.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.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.public ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException
MBeanRegistration
interface.
The call returns an ObjectInstance
object representing
the newly created MBean.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 constructor to be invoked.signature
- An array containing the signature of constructor to be invoked.loaderName
- The object name of the class loader to be used.ObjectInstance
, containing the
ObjectName
and the Java class name of
the newly instantiated MBean.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.MBeanException
- The constructor of the MBean has thrown an exception.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.public java.io.ObjectInputStream deserialize(ObjectName name, byte[] data) throws InstanceNotFoundException, OperationsException
name
- The name of the MBean whose class loader should be used
for the de-serialization.data
- The byte array to be de-sererialized.InstanceNotFoundException
- The MBean specified is not found.OperationsException
- Any of the usual Input/Output related exceptions.public java.io.ObjectInputStream deserialize(java.lang.String className, byte[] data) throws OperationsException, ReflectionException
className
- The name of the class whose class loader should be used
for the de-serialization.data
- The byte array to be de-sererialized.OperationsException
- Any of the usual Input/Output related exceptions.ReflectionException
- The specified class could not be
loaded by the default loader repository.public java.io.ObjectInputStream deserialize(java.lang.String className, ObjectName loaderName, byte[] data) throws InstanceNotFoundException, OperationsException, ReflectionException
className
- The name of the class whose class loader should be
used for the de-serialization.data
- The byte array to be de-sererialized.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.InstanceNotFoundException
- The specified class loader MBean
is not found.OperationsException
- Any of the usual Input/Output related exceptions.ReflectionException
- The specified class could not be
loaded by the specified class loader.public java.lang.Object getAttribute(ObjectName name, java.lang.String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException
name
- The object name of the MBean from which the attribute is
to be retrieved.attribute
- A String specifying the name of the attribute to be retrieved.AttributeNotFoundException
- The attribute specified is
not accessible in the MBean.MBeanException
- Wraps an exception thrown by the MBean's getter.InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.ReflectionException
- Wraps a java.lang.Exception
thrown when trying to invoke the setter.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The object name in parameter is null
or the attribute in parameter is null.public AttributeList getAttributes(ObjectName name, java.lang.String[] attributes) throws InstanceNotFoundException, ReflectionException
name
- The object name of the MBean from which the attributes are
retrieved.attributes
- A list of the attributes to be retrieved.InstanceNotFoundException
- The MBean specified is
not registered in the MBean server.ReflectionException
- An exception occurred when trying to
invoke the getAttributes method of a Dynamic MBean.RuntimeOperationsException
- Wrap a
java.lang.IllegalArgumentException
:
The object name in parameter is null
or attributes in parameter is null.public java.lang.String getDefaultDomain()
public java.lang.Integer getMBeanCount()
public MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException, ReflectionException
name
- The name of the MBean to analyzeMBeanInfo
allowing the retrieval
of all attributes and operations of this MBean.IntrospectionException
- An exception occurs during introspection.InstanceNotFoundException
- The MBean specified is not found.ReflectionException
- An exception occurred when trying
to invoke the getMBeanInfo of a Dynamic MBean.public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException
ObjectInstance
for a given MBean registered
with the MBean server.name
- The object name of the MBean.ObjectInstance
associated to the
MBean specified by name.InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.public java.lang.Object instantiate(java.lang.String className) throws ReflectionException, MBeanException
Default Loader Repository
).
The object's class should have a public constructor. It returns a
reference to the newly created object. The newly created object is
not registered in the MBean server.className
- The class name of the object to be instantiated.ReflectionException
- Wraps a
java.lang.ClassNotFoundException
or the java.lang.Exception
that occurred
when trying to invoke the object's constructor.MBeanException
- The constructor of the object has thrown an exception.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The className passed in parameter is null.public java.lang.Object instantiate(java.lang.String className, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, MBeanException
Default 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.className
- The class name of the object to be instantiated.params
- An array containing the parameters of the constructor to be invoked.signature
- An array containing the signature of the constructor to be invoked.ReflectionException
- Wraps a
java.lang.ClassNotFoundException
or the java.lang.Exception
that occurred
when trying to invoke the object's constructor.MBeanException
- The constructor of the object has thrown an exceptionRuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The className passed in parameter is null.public java.lang.Object instantiate(java.lang.String className, ObjectName loaderName) throws ReflectionException, MBeanException, InstanceNotFoundException
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. It returns a reference to the newly created
object. The newly created object is not registered in the MBean server.className
- The class name of the MBean to be instantiated.loaderName
- The object name of the class loader to be used.ReflectionException
- Wraps a
java.lang.ClassNotFoundException
or the java.lang.Exception
that occurred
when trying to invoke the object's constructor.MBeanException
- The constructor of the object has thrown an exception.InstanceNotFoundException
- The specified class loader is
not registered in the MBaenServer.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The className passed in parameter is null.public java.lang.Object instantiate(java.lang.String className, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, MBeanException, InstanceNotFoundException
className
- The class name of the object to be instantiated.params
- An array containing the parameters of the constructor to be invoked.signature
- An array containing the signature of the constructor to be invoked.loaderName
- The object name of the class loader to be used.ReflectionException
- Wraps a
java.lang.ClassNotFoundException
or the java.lang.Exception
that occurred
when trying to invoke the object's constructor.MBeanException
- The constructor of the object has thrown
an exception.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.public java.lang.Object invoke(ObjectName name, java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) throws InstanceNotFoundException, MBeanException, ReflectionException
name
- The object name of the MBean on which the method is to be invoked.operationName
- The name of the operation to be invoked.params
- An array containing the parameters to be set when
the operation is invoked.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.InstanceNotFoundException
- The MBean specified is
not registered in the MBean server.MBeanException
- Wraps an exception thrown by the MBean's invoked method.ReflectionException
- Wraps a java.lang.Exception
thrown while trying to invoke the method.public boolean isRegistered(ObjectName name)
name
- The object name of the MBean to be checked.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The object name in parameter is null.public boolean isInstanceOf(ObjectName name, java.lang.String className) throws InstanceNotFoundException
name
- The ObjectName
of the MBean.className
- The name of the class.InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.public java.util.Set queryMBeans(ObjectName name, QueryExp query)
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.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.query
- The query expression to be applied for selecting MBeans. If
null no query expression will be applied for selecting MBeans.ObjectInstance
objects for
the selected MBeans. If no MBean satisfies the query
an empty list is returned.public java.util.Set queryNames(ObjectName name, QueryExp query)
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.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.query
- The query expression to be applied for selecting MBeans. If
null no query expression will be applied for selecting MBeans.public ObjectInstance registerMBean(java.lang.Object object, ObjectName name) throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException
MBeanRegistration
interface.
The call returns an ObjectInstance
object
representing the registered MBean.object
- The MBean to be registered as an MBean.name
- The object name of the MBean. May be null.ObjectInstance
for the registered MBean.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.NotCompliantMBeanException
- This object is not a JMX compliant MBean.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The object passed in parameter is null
or no object name is specified.public void removeNotificationListener(ObjectName name, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException
name
- The name of the MBean on which the listener should be removed.listener
- The listener object which will handle the notifications
emitted by the registered MBean. This method will remove
all the information related to this listener.InstanceNotFoundException
- The MBean name provided
does not match any of the registered MBeans.ListenerNotFoundException
- The couple (listener,handback)
is not registered in the MBean. The exception message
contains either "listener", "handback" or the object name
depending on which object cannot be found.public void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException
name
- The name of the MBean on which the listener should be removed.listener
- The object name of the listener which will handle the
notifications emitted by the registered MBean. This method
will remove all the information related to this listener.InstanceNotFoundException
- The MBean name provided
does not match any of the registered MBeans.ListenerNotFoundException
- The couple (listener,handback) is
not registered in the MBean. The exception message
contains either "listener", "handback" or the object name
depending on which object cannot be found.public void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException
name
- The name of the MBean within which the attribute is to be set.attribute
- The identification of the attribute to be set and
the value it is to be set to.InstanceNotFoundException
- The MBean specified is
not registered in the MBean server.AttributeNotFoundException
- The attribute specified is
not accessible in the MBean.InvalidAttributeValueException
- The value specified for
the attribute is not valid.MBeanException
- Wraps an exception thrown by the MBean's setter.ReflectionException
- Wraps a java.lang.Exception
thrown when trying to invoke the setter.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The object name in parameter is null
or the attribute in parameter is null.public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException, ReflectionException
name
- The object name of the MBean within which the attributes
are to be set.attributes
- A list of attributes: The identification of the
attributes to be set and the values they are to be set to.InstanceNotFoundException
- The MBean specified is
not registered in the MBean server.ReflectionException
- An exception occurred when trying to
invoke the getAttributes method of a Dynamic MBean.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The object name in parameter is null
or attributes in parameter is null.public void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException
name
- The object name of the MBean to be de-registered.InstanceNotFoundException
- The MBean specified is
not registered in the MBean server.MBeanRegistrationException
- The preDeregister
((MBeanRegistration
interface) method of
the MBean has thrown an exception.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException
:
The object name in parameter is null
or the MBean you are when trying to de-register is the
MBeanServerDelegate
MBean.
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |