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.
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.
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.
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.
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
ObjectNametheObjectNameof the MBeanServerDelegate . ThisObjectNameis: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,
classNameis 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
attrNameis 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
addNotificationListenermethods, the caller's permissions must imply MBeanPermission(className, null, name, "addNotificationListener") .For the
removeNotificationListenermethods, 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
queryMBeansexcept that"queryNames"is used instead of"queryMBeans"in theMBeanPermissionobjects. 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=xis 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
deserializemethods, the required permissions are the same as for the methods that replace them.For the
instantiatemethods, 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
classNameis the string returned by getClassName() for an object of this class.If the
MBeanPermissioncheck succeeds, the MBean's class is validated by checking that its ProtectionDomain implies MBeanTrustPermission("register") .Finally, if the
nameargument is null, anotherMBeanPermissioncheck is made using theObjectNamereturned by MBeanRegistration.preRegister .For the
createMBeanmethods, the caller's permissions must imply the permissions needed by the equivalentinstantiatefollowed byregisterMBean.For the unregisterMBean method, the caller's permissions must imply MBeanPermission(className, null, name, "unregisterMBean") .