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 ( is null), then no checks are made.
Assuming there is a security manager, the checks are made as
detailed below. In what follows, className is the
string returned by
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()
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 .
For the queryMBeans
method, the
caller's permissions must imply
.
Additionally, for each MBean that matches name,
if the caller's permissions do not imply
, 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 Query#attr(String) , Query#attr(String,String) , and Query#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
. Additionally,
for each domain d in the returned array, if the caller's
permissions do not imply ,
"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 .
For the getClassLoaderFor method, the caller's permissions must imply .
For the getClassLoaderRepository method, the caller's permissions must imply .
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
.
For the registerMBean
method, the
caller's permissions must imply
. Here
className is the string returned by MBeanInfo#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#MBeanTrustPermission(String)
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 .
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.
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.
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) .
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) .
De-serializes a byte array in the context of the class loader of an MBean.
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.
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.
Return the named java.lang.ClassLoader .
Return the java.lang.ClassLoader that was used for loading the class of the named MBean.
Return the ClassLoaderRepository for this MBeanServer.
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.
ObjectInstance for a given MBean
registered with the MBean server.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) .
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.
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) .
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.
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.
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.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.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.
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.
If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.
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.