|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.adventnet.jmx.MBeanServerImpl
This is the implementation class for MBean manipulation on the agent side. It contains the necessary methods 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.
Constructor Summary | |
MBeanServerImpl()
Default Constructor |
|
MBeanServerImpl(java.lang.String defaultDomain)
Creates an MBeanServer with the specified default domain name. |
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 a MBean with the MBeanServer. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates and registers a MBean with the MBeanServer. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name,
ObjectName loaderName)
Instantiates and registers a MBean with the MBeanServer. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName name,
ObjectName loaderName,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates and registers a MBean with the MBeanServer. |
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 the MBean naming. |
java.util.Hashtable |
getLoaderTable()
Returns the table that has the loader references os the mbeans. |
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. |
java.lang.Object |
getObjectInClassLoader(ObjectName name,
byte[] entityBody)
This method de-serializes an object in the context of a given MBean class loader. |
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 MBeanServer. |
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 MBeanServer. |
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 action on an MBean. |
boolean |
isInSameClassLoader(ObjectName name,
java.lang.Object object)
This method checks if an object has been loaded in the context of a MBean class loader. |
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 MBeanServer. |
java.util.Set |
queryMBeans(ObjectName name,
QueryExp query)
Gets MBeans controlled by the MBeanServer. |
java.util.Set |
queryNames(ObjectName name,
QueryExp query)
Gets the names of MBeans controlled by the MBeanServer. |
ObjectInstance |
registerMBean(java.lang.Object object,
ObjectName name)
Registers a pre-existing object as an MBean with the MBeanServer. |
void |
removeNotificationListener(ObjectName name,
NotificationListener listener)
Enables to remove a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName name,
ObjectName listener)
Enables a listener for an MBean to be removed. |
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 MBeanServer. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MBeanServerImpl()
public MBeanServerImpl(java.lang.String defaultDomain)
Method Detail |
public boolean isRegistered(ObjectName name)
isRegistered
in interface MBeanServer
name
- The object name of the MBean to be checked.public boolean isInstanceOf(ObjectName name, java.lang.String className) throws InstanceNotFoundException
isInstanceOf
in interface MBeanServer
name
- The object name of the MBean to be checked.className
- The name of the class.InstanceNotFoundException
- The MBean specified is not registered in the MBean server.public java.lang.String getDefaultDomain()
getDefaultDomain
in interface MBeanServer
public java.util.Set queryMBeans(ObjectName name, QueryExp query)
queryMBeans
in interface MBeanServer
name
- The object name pattern identifying the MBeans to be
retrieved. If null orempty all the MBeans registered
will be retrieved.query
- The query expression to be applied for selecting MBeans.public java.util.Set queryNames(ObjectName name, QueryExp query)
queryNames
in interface MBeanServer
name
- The object name pattern identifying the MBean names
to be retrieved. If null or empty, the name of all
registered MBeans will be retrieved.query
- The query expression to be applied for selecting MBeans.public ObjectInstance registerMBean(java.lang.Object object, ObjectName name) throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException
registerMBean
in interface MBeanServer
object
- The Java Bean to be registered as an MBean.name
- The object name of the MBean. May be null.InstanceAlreadyExistsException
- The MBean
is already under the control of the MBeanServer.MBeanRegistrationException
- The preRegister
(MBeanRegistration interface) method of the MBean has
thrown an exception. The MBean will not be registered.NotCompliantMBeanException
- This object is
not an JMX compliant MBeanpublic void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException
unregisterMBean
in interface MBeanServer
name
- The object name of the MBean to be de-registered.InstanceNotFoundException
- The
specified MBean is not registered in the MBeanServer.MBeanRegistrationException
- The
preDeregister (MBeanRegistration interface) method of the
MBean has thrown an exception.public java.lang.Object getAttribute(ObjectName name, java.lang.String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException
getAttribute
in interface MBeanServer
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
specified attribute is not accessible in the MBean.MBeanException
- Wraps an exception
thrown by the MBean's getter.InstanceNotFoundException
- The
specified MBean is not registered in the MBeanServer.ReflectionException
- Wraps an
java.lang.Exception thrown while trying to invoke the setter.public AttributeList getAttributes(ObjectName name, java.lang.String[] attributes) throws InstanceNotFoundException, ReflectionException
getAttributes
in interface MBeanServer
name
- The object name of the MBean from which the
attributes are to be retrieved.attributes
- A list of the attributes to be retrieved.InstanceNotFoundException
- The
specified MBean is not registered in the MBeanServer.public java.lang.Object invoke(ObjectName name, java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) throws InstanceNotFoundException, MBeanException, ReflectionException
invoke
in interface MBeanServer
name
- The object name of the MBean on which the method is to be invoked.actionName
- The name of the action to be invoked.params
- An array containing the parameters to be set when the action is invokedsignature
- An array containing the signature of the action.
The class objects will be loaded using the same class loader
as the one used for loading the MBean on which the action was invoked.InstanceNotFoundException
- The
specified MBean is not registered in the MBeanServer.MBeanException
- Wraps an exception
thrown by the MBean's invoked method.ReflectionException
- Wraps an
java.lang.Exception thrown while trying to invoke the method.public void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException
setAttribute
in interface MBeanServer
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
specified MBean is not registered in the MBeanServer.AttributeNotFoundException
- The
specified attribute is not accessible in the MBean.InvalidAttributeValueException
- The
specified value for the attribute is not valid.MBeanException
- Wraps an exception
thrown by the MBean's setter.ReflectionException
- Wraps an
java.lang.Exception thrown while trying to invoke the setter.public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException, ReflectionException
setAttributes
in interface MBeanServer
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 specified
MBean is not registered in the MBeanServer.public MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException, ReflectionException
getMBeanInfo
in interface MBeanServer
name
- The name of the MBean to analyzejava.beans.IntrospectionException
- An exception
occurs during introspection.InstanceNotFoundException
- The specified
MBean is not found.public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException
getObjectInstance
in interface MBeanServer
name
- The object name of the MBean.InstanceNotFoundException
- The MBean specified
is not registered in the MBean server.public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException
addNotificationListener
in interface MBeanServer
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.java.lang.IllegalArgumentException
- The object with name "name"
doesn't implements NotificationBroadcasterInstanceAlreadyExistsException
- The couple
(listener,handback) is already registered in the MBean.public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException
addNotificationListener
in interface MBeanServer
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.java.lang.IllegalArgumentException
- The object with name "name"
doesn't implements NotificationBroadcasterInstanceAlreadyExistsException
- The couple
(listener,handback) is already registered in the MBean.public ObjectInstance createMBean(java.lang.String className, ObjectName name) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
createMBean
in interface MBeanServer
className
- The class name of the MBean to be instantiated.name
- The object name of the MBean. May be null.ReflectionException
- Wraps Wraps a
ClassNotFoundException or a java.lang.Exception that
occured trying to invoke the MBean's constructor.InstanceAlreadyExistsException
- The MBean is
already under the control of the MBeanServer.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 an JMX compliant MBeanpublic ObjectInstance createMBean(java.lang.String className, ObjectName name, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
createMBean
in interface MBeanServer
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.ReflectionException
- Wraps Wraps a
ClassNotFoundException or a java.lang.Exception that
occured trying to invoke the MBean's constructor.InstanceAlreadyExistsException
- The MBean is
already under the control of the MBeanServer.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 exceptionpublic ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException
createMBean
in interface MBeanServer
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.InstanceAlreadyExistsException
- The MBean is
already under the control of the MBeanServer.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
an JMX compliant MBeanInstanceNotFoundException
- The specified class
loader is not registered in the MBeanServer.public ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, RuntimeMBeanException, NotCompliantMBeanException, InstanceNotFoundException
createMBean
in interface MBeanServer
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.loaderName
- The object name of the class loader to be used.ReflectionException
- Wraps Wraps a
ClassNotFoundException or a java.lang.Exception that
occured trying to invoke the MBean's constructor.InstanceAlreadyExistsException
- The MBean is
already under the control of the MBeanServer.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 exceptionpublic java.io.ObjectInputStream deserialize(ObjectName name, byte[] data) throws InstanceNotFoundException, OperationsException
deserialize
in interface MBeanServer
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
deserialize
in interface MBeanServer
name
- 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 repositorypublic java.io.ObjectInputStream deserialize(java.lang.String className, ObjectName loaderName, byte[] data) throws InstanceNotFoundException, OperationsException, ReflectionException
deserialize
in interface MBeanServer
name
- 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.Integer getMBeanCount()
getMBeanCount
in interface MBeanServer
public java.lang.Object getObjectInClassLoader(ObjectName name, byte[] entityBody) throws InstanceNotFoundException, java.lang.ClassNotFoundException, java.io.OptionalDataException, java.io.IOException
name
- The name of the MBean which defines the class loaderentityBody
- The byte array to be de-sererialized.InstanceNotFoundException
- The specified
MBean is not found.java.lang.ClassNotFoundException
- The object which has to be
deserialized is not found the context the the MBean class loaderjava.io.OptionalDataException
- Primitive data was found in
the stream instead of objects.java.io.IOException
- Any of the usual Input/Output related
exceptions.public java.lang.Object instantiate(java.lang.String className) throws ReflectionException, MBeanException
instantiate
in interface MBeanServer
className
- The class name of the object to be instantiated.ReflectionException
- Wraps a
ClassNotFoundException or the java.lang.Exception that
occured trying to invoke the object's constructor.MBeanException
- The constructor of the object
has thrown an exceptionpublic java.lang.Object instantiate(java.lang.String className, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, MBeanException
instantiate
in interface MBeanServer
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
ClassNotFoundException or the java.lang.Exception that
occured trying to invoke the object's constructor.MBeanException
- The constructor of the object
has thrown an exceptionpublic java.lang.Object instantiate(java.lang.String className, ObjectName loaderName) throws ReflectionException, MBeanException, InstanceNotFoundException
instantiate
in interface MBeanServer
className
- The class name of the MBean to be instantiated.loaderName
- The object name of the class loader to be used.ReflectionException
- Wraps a
ClassNotFoundException or the java.lang.Exception
that occured 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 MBeanServer.public java.lang.Object instantiate(java.lang.String className, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, MBeanException, InstanceNotFoundException
instantiate
in interface MBeanServer
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
ClassNotFoundException or the java.lang.Exception that
occured trying to invoke the object's constructor.MBeanException
- The constructor of the object has
thrown an exceptionInstanceNotFoundException
- The specified class
loader is not registered in the MBeanServer.public boolean isInSameClassLoader(ObjectName name, java.lang.Object object) throws InstanceNotFoundException
name
- The name of the MBean which defines the class loaderobject
- The object to check.InstanceNotFoundException
- The specified
MBean is not found.public void removeNotificationListener(ObjectName name, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServer
removeNotificationListener
in interface MBeanServer
java.lang.IllegalArgumentException
- The object with name "name"
doesn't implements NotificationBroadcasterpublic void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException
removeNotificationListener
in interface MBeanServer
name
- The name of the MBean on which the listener should be removedlistener
- The listener name which will handles notifications
emitted by the registered MBean. This method will remove
all information related to this listener.InstanceNotFoundException
- The MBean name or
the listener name doesn't correspond to a registered MBeanListenerNotFoundException
- 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.java.lang.IllegalArgumentException
- The object with name "name"
doesn't implements NotificationBroadcaster or the object
with name "listener" doesn't implements NotificationListener.
The faulty ObjectName string representation can be obtained
by means of the getMessage() method of the
IllegalArgumentException object.public java.util.Hashtable getLoaderTable()
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |