javax.management.MBeanServer |
![]() |
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.
User code does not usually implement this interface. Instead,
an object that implements this interface is obtained with one of
the methods in the MBeanServerFactory
class.
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
a 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
.
An object obtained from the createMBeanServer
or
newMBeanServer
methods of the MBeanServerFactory
class applies security
checks to its methods, as follows.
First, if there is no security manager (getSecurityManager()
is null), then an implementation of
this interface is free not to make any checks.
Assuming that there is a security manager, or that the
implementation chooses to make checks anyway, the checks are made
as detailed below. In what follows, className
is the
string returned by getClassName()
for the target
MBean.
If a security check fails, the method throws SecurityException
.
For methods that can throw InstanceNotFoundException
,
this exception is thrown for a non-existent MBean, regardless of
permissions. This is because a non-existent MBean has no
className
.
For the invoke
method, the caller's
permissions must imply MBeanPermission(className, operationName, name, "invoke")
.
For the getAttribute
method, the
caller's permissions must imply MBeanPermission(className, attribute, name, "getAttribute")
.
For the getAttributes
method, the
caller's permissions must imply MBeanPermission(className, null, name, "getAttribute")
.
Additionally, for each attribute a in the AttributeList
, if the caller's permissions do not imply MBeanPermission(className, a, name, "getAttribute")
, the
MBean server will behave as if that attribute had not been in the
supplied list.
For the setAttribute
method, the
caller's permissions must imply MBeanPermission(className, attrName, name, "setAttribute")
, where
attrName
is attribute.getName()
.
For the setAttributes
method, the
caller's permissions must imply MBeanPermission(className, null, name, "setAttribute")
.
Additionally, for each attribute a in the AttributeList
, if the caller's permissions do not imply MBeanPermission(className, a, name, "setAttribute")
, the
MBean server will behave as if that attribute had not been in the
supplied list.
For the addNotificationListener
methods,
the caller's permissions must imply MBeanPermission(className, null, name,
"addNotificationListener")
.
For the removeNotificationListener
methods,
the caller's permissions must imply MBeanPermission(className, null, name,
"removeNotificationListener")
.
For the getMBeanInfo
method, the
caller's permissions must imply MBeanPermission(className, null, name, "getMBeanInfo")
.
For the getObjectInstance
method,
the caller's permissions must imply MBeanPermission(className, null, name, "getObjectInstance")
.
For the isInstanceOf
method, the
caller's permissions must imply MBeanPermission(className, null, name, "isInstanceOf")
.
For the queryMBeans
method, the
caller's permissions must imply MBeanPermission(null, null, name, "queryMBeans")
.
Additionally, for each MBean that matches name
,
if the caller's permissions do not imply MBeanPermission(className, null, name, "queryMBeans")
, the
MBean server will behave as if that MBean did not exist.
Certain query elements perform operations on the MBean server.
If the caller does not have the required permissions for a given
MBean, that MBean will not be included in the result of the query.
The standard query elements that are affected are attr(String)
, attr(String, String)
, and classattr()
.
For the queryNames
method, the checks
are the same as for queryMBeans
except that
"queryNames"
is used instead of
"queryMBeans"
in the MBeanPermission
objects. Note that a "queryMBeans"
permission implies
the corresponding "queryNames"
permission.
For the getDomains
method, the caller's
permissions must imply MBeanPermission(null, null, name, "getDomains")
. Additionally,
for each domain d in the returned array, if the caller's
permissions do not imply MBeanPermission(null, null, new ObjectName("d:x=x"),
"getDomains")
, the domain is eliminated from the array. Here,
x=x
is any key=value pair, needed to
satisfy ObjectName's constructor but not otherwise relevant.
For the getClassLoader
method, the
caller's permissions must imply MBeanPermission(className, null, loaderName,
"getClassLoader")
.
For the getClassLoaderFor
method,
the caller's permissions must imply MBeanPermission(className, null, mbeanName,
"getClassLoaderFor")
.
For the getClassLoaderRepository
method, the caller's permissions must
imply MBeanPermission(null, null, null, "getClassLoaderRepository")
.
For the deprecated deserialize
methods, the
required permissions are the same as for the methods that replace
them.
For the instantiate
methods, the caller's
permissions must imply MBeanPermission(className, null, null, "instantiate")
.
For the registerMBean
method, the
caller's permissions must imply MBeanPermission(className, null, name, "registerMBean")
. Here
className
is the string returned by getClassName()
for an object of this class.
If the MBeanPermission
check succeeds, the MBean's
class is validated by checking that its ProtectionDomain
implies MBeanTrustPermission("register")
.
Finally, if the name
argument is null, another
MBeanPermission
check is made using the
ObjectName
returned by MBeanRegistration.preRegister
.
For the createMBean
methods, the caller's
permissions must imply the permissions needed by the equivalent
instantiate
followed by
registerMBean
.
For the unregisterMBean
method,
the caller's permissions must imply MBeanPermission(className, null, name, "unregisterMBean")
.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a listener to a registered MBean. | |||||||||||
Adds a listener to a registered MBean. | |||||||||||
Instantiates and registers an MBean in the MBean server. | |||||||||||
Instantiates and registers an MBean in the MBean server.
| |||||||||||
Instantiates and registers an MBean in the MBean server. | |||||||||||
Instantiates and registers an MBean in the MBean server.
| |||||||||||
This method is deprecated.
Use
getClassLoaderFor to
obtain the appropriate class loader for deserialization.
| |||||||||||
This method is deprecated.
Use
getClassLoader to obtain
the class loader for deserialization.
| |||||||||||
This method is deprecated.
Use
getClassLoaderRepository() to obtain the
class loader repository and use it to deserialize.
| |||||||||||
Gets the value of a specific attribute of a named MBean.
| |||||||||||
Enables the values of several attributes of a named MBean.
| |||||||||||
Return the named | |||||||||||
Return the | |||||||||||
Return the ClassLoaderRepository for this MBeanServer. | |||||||||||
Returns the default domain used for naming the MBean.
| |||||||||||
Returns the list of domains in which any MBean is currently registered. | |||||||||||
Returns the number of MBeans registered in the MBean server.
| |||||||||||
This method discovers the attributes and operations that an
MBean exposes for management.
| |||||||||||
Gets the
ObjectInstance for a given MBean
registered with the MBean server. | |||||||||||
Instantiates an object. | |||||||||||
Instantiates an object using the list of all class loaders
registered in the MBean server | |||||||||||
Instantiates an object using the list of all class loaders
registered in the MBean server's | |||||||||||
Instantiates an object using the class Loader specified by its
| |||||||||||
Invokes an operation on an MBean.
| |||||||||||
Returns true if the MBean specified is an instance of the specified class, false otherwise. | |||||||||||
Checks whether an MBean, identified by its object name, is
already registered with the MBean server.
| |||||||||||
Gets MBeans controlled by the MBean server.
| |||||||||||
Gets the names of MBeans controlled by the MBean server.
| |||||||||||
Registers a pre-existing object as an MBean with the MBean
server.
| |||||||||||
Removes a listener from a registered MBean. | |||||||||||
Removes a listener from a registered MBean.
| |||||||||||
Removes a listener from a registered MBean. | |||||||||||
Removes a listener from a registered MBean. | |||||||||||
Sets the value of a specific attribute of a named MBean.
| |||||||||||
Sets the values of several attributes of a named MBean.
| |||||||||||
Unregisters an MBean from the MBean server.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
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.
name | The name of the MBean on which the listener should be added. |
---|---|
listener | The listener object which will handle the notifications emitted by the registered MBean. |
filter | The filter object. If filter is null, no filtering will be performed before handling notifications. |
handback | The context to be sent to the listener when a notification is emitted. |
InstanceNotFoundException |
---|
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.
name | The name of the MBean on which the listener should be added. |
---|---|
listener | The object name of the listener which will handle the notifications emitted by the registered MBean. |
filter | The filter object. If filter is null, no filtering will be performed before handling notifications. |
handback | The context to be sent to the listener when a notification is emitted. |
InstanceNotFoundException |
---|
Instantiates and registers an MBean in the MBean server. The
MBean server will use its Default Loader
Repository
to load the class of the MBean. An object name is
associated to the MBean. If the object name given is null, the
MBean must provide its own name by implementing the MBeanRegistration
interface
and returning the name from the preRegister
method.
This method is equivalent to createMBean(className, name, (Object[]) null, (String[])
null)
.
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. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.Instantiates and registers an MBean in the MBean server. The
MBean server will use its Default Loader
Repository
to load the class of the MBean. An object name is
associated to the MBean. If the object name given is null, the
MBean must provide its own name by implementing the MBeanRegistration
interface
and returning the name from the preRegister
method.
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. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.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 MBeanRegistration
interface
and returning the name from the preRegister
method.
This method is equivalent to createMBean(className, name, loaderName, (Object[]) null,
(String[]) null)
.
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. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.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
MBeanRegistration
interface and returning the name from the preRegister
method.
className | The class name of the MBean to be instantiated. |
---|---|
name | The object name of the MBean. May be null. |
loaderName | The object name of the class loader to be used. |
params | An array containing the parameters of the constructor to be invoked. |
signature | An array containing the signature of the constructor to be invoked. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.
This method is deprecated.
Use getClassLoaderFor
to
obtain the appropriate class loader for deserialization.
De-serializes a byte array in the context of the class loader of an MBean.
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. |
This method is deprecated.
Use getClassLoader
to obtain
the class loader for deserialization.
De-serializes a byte array in the context of a given MBean class loader. The class loader is the one that loaded the class with name "className". The name of the class loader to be used for loading the specified class is specified. If null, the MBean Server's class loader will be used.
className | The name of the class whose class loader should be used for the de-serialization. |
---|---|
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. |
data | The byte array to be de-sererialized. |
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. |
This method is deprecated.
Use getClassLoaderRepository()
to obtain the
class loader repository and use it to deserialize.
De-serializes a byte array in the context of a given MBean
class loader. The class loader is found by loading the class
className
through the Class Loader
Repository
. The resultant class's class loader is the one to
use.
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 class loader repository |
Gets the value of a specific attribute of a named MBean. The MBean is identified by its object name.
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. |
Enables the values of several attributes of a named MBean. The MBean is identified by its object name.
name | The object name of the MBean from which the attributes are retrieved. |
---|---|
attributes | A list of the attributes to be retrieved. |
Return the named ClassLoader
.
loaderName | The ObjectName of the ClassLoader. May be null, in which case the MBean server's own ClassLoader is returned. |
---|
.loadClass(s)
is the
same as l.loadClass(s)
for any string s.
InstanceNotFoundException | if the named ClassLoader is not found. |
---|
Return the ClassLoader
that was used for
loading the class of the named MBean.
mbeanName | The ObjectName of the MBean. |
---|
.loadClass(s)
is the
same as l.loadClass(s)
for any string s.
InstanceNotFoundException | if the named MBean is not found. |
---|
Return the ClassLoaderRepository for this MBeanServer.
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.
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
getDomain()
is equal to that
string. The order of strings within the returned array is
not defined.
Returns the number of MBeans registered in the MBean server.
This method discovers the attributes and operations that an MBean exposes for management.
name | The name of the MBean to analyze |
---|
MBeanInfo
allowing the
retrieval of all attributes and operations of this MBean.Gets the ObjectInstance
for a given MBean
registered with the MBean server.
name | The object name of the MBean. |
---|
ObjectInstance
associated with the MBean
specified by name. The contained ObjectName
is name
and the contained class name is
getMBeanInfo(name)
.getClassName()
.InstanceNotFoundException |
---|
Instantiates an object. The class loader to be used is identified by its object name. If the object name of the loader is null, the ClassLoader that loaded the MBean server will be used. 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. |
---|---|
loaderName | The object name of the class loader to be used. |
params | An array containing the parameters of the constructor to be invoked. |
signature | An array containing the signature of the constructor to be invoked. |
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.
|
Instantiates an object using the list of all class loaders
registered in the MBean server Class 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 exception |
RuntimeOperationsException | Wraps a
java.lang.IllegalArgumentException : The className
passed in parameter is null.
|
Instantiates an object using the list of all class loaders
registered in the MBean server's Class Loader
Repository
. The object's class should have a public
constructor. This method returns a reference to the newly
created object. The newly created object is not registered in
the MBean server.
This method is equivalent to instantiate(className, (Object[]) null, (String[]) null)
.
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.
|
Instantiates an object using the class Loader specified by its
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. This method
returns a reference to the newly created object. The newly
created object is not registered in the MBean server.
This method is equivalent to instantiate(className, loaderName, (Object[]) null, (String[])
null)
.
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 MBeanServer. |
RuntimeOperationsException | Wraps a
java.lang.IllegalArgumentException : The className
passed in parameter is null.
|
Invokes an operation on an MBean.
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. |
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 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.
name | The ObjectName of the MBean. |
---|---|
className | The name of the class. |
InstanceNotFoundException |
---|
Checks whether an MBean, identified by its object name, is already registered with the MBean server.
name | The object name of the MBean to be checked. |
---|
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.
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.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.
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. |
---|---|
query | The query expression to be applied for selecting MBeans. If null no query expression will be applied for selecting MBeans. |
Registers a pre-existing object as an MBean with the MBean
server. If the object name given is null, the MBean must
provide its own name by implementing the MBeanRegistration
interface
and returning the name from the preRegister
method.
object | The MBean to be registered as an MBean. |
---|---|
name | The object name of the MBean. May be null. |
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
registered MBean. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.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.
|
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.
name | The name of the MBean on which the listener should be removed. |
---|---|
listener | The object name of the listener to be removed. |
filter | The filter that was specified when the listener was added. |
handback | The handback that was specified when the listener was added. |
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.
name | The name of the MBean on which the listener should be removed. |
---|---|
listener | The object name of the listener to be removed. |
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.
name | The name of the MBean on which the listener should be removed. |
---|---|
listener | The listener to be removed. |
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.
name | The name of the MBean on which the listener should be removed. |
---|---|
listener | The listener to be removed. |
filter | The filter that was specified when the listener was added. |
handback | The handback that was specified when the listener was added. |
Sets the value of a specific attribute of a named MBean. The MBean is identified by its object name.
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. |
Sets the values of several attributes of a named MBean. The MBean is identified by its object name.
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. |
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.
name | The object name of the MBean to be unregistered. |
---|