MBeanServerpublic interface MBeanServer implements MBeanServerConnectionThis 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 {@link 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 {@link javax.management.MBeanServerNotification
MBeanServerNotification} Notification is emitted. To register an
object as listener to MBeanServerNotifications you should call the
MBean server method {@link #addNotificationListener
addNotificationListener} with ObjectName the
ObjectName of the {@link
javax.management.MBeanServerDelegate MBeanServerDelegate}. This
ObjectName is:
JMImplementation:type=MBeanServerDelegate .
An object obtained from the {@link
MBeanServerFactory#createMBeanServer(String) createMBeanServer} or
{@link MBeanServerFactory#newMBeanServer(String) newMBeanServer}
methods of the {@link MBeanServerFactory} class applies security
checks to its methods, as follows.
First, if there is no security manager ({@link
System#getSecurityManager()} 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 {@link MBeanInfo#getClassName()} for the target
MBean.
If a security check fails, the method throws {@link
SecurityException}.
For methods that can throw {@link 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 {@link #invoke invoke} method, the caller's
permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, operationName, name, "invoke")}.
For the {@link #getAttribute getAttribute} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, attribute, name, "getAttribute")}.
For the {@link #getAttributes getAttributes} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "getAttribute")}.
Additionally, for each attribute a in the {@link
AttributeList}, if the caller's permissions do not imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, a, name, "getAttribute")}, the
MBean server will behave as if that attribute had not been in the
supplied list.
For the {@link #setAttribute setAttribute} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, attrName, name, "setAttribute")}, where
attrName is {@link Attribute#getName()
attribute.getName()}.
For the {@link #setAttributes setAttributes} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "setAttribute")}.
Additionally, for each attribute a in the {@link
AttributeList}, if the caller's permissions do not imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
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 {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name,
"addNotificationListener")}.
For the removeNotificationListener methods,
the caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name,
"removeNotificationListener")}.
For the {@link #getMBeanInfo getMBeanInfo} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "getMBeanInfo")}.
For the {@link #getObjectInstance getObjectInstance} method,
the caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "getObjectInstance")}.
For the {@link #isInstanceOf isInstanceOf} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "isInstanceOf")}.
For the {@link #queryMBeans queryMBeans} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(null, null, name, "queryMBeans")}.
Additionally, for each MBean that matches name ,
if the caller's permissions do not imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
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 {@link
Query#attr(String)}, {@link Query#attr(String,String)}, and {@link
Query#classattr()}.
For the {@link #queryNames 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 {@link #getDomains getDomains} method, the caller's
permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(null, null, name, "getDomains")}. Additionally,
for each domain d in the returned array, if the caller's
permissions do not imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
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 {@link #getClassLoader getClassLoader} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, loaderName,
"getClassLoader")}.
For the {@link #getClassLoaderFor getClassLoaderFor} method,
the caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, mbeanName,
"getClassLoaderFor")}.
For the {@link #getClassLoaderRepository
getClassLoaderRepository} method, the caller's permissions must
imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
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 {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, null, "instantiate")}.
For the {@link #registerMBean registerMBean} method, the
caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "registerMBean")}. Here
className is the string returned by {@link
MBeanInfo#getClassName()} for an object of this class.
If the MBeanPermission check succeeds, the MBean's
class is validated by checking that its {@link
java.security.ProtectionDomain ProtectionDomain} implies {@link
MBeanTrustPermission#MBeanTrustPermission(String)
MBeanTrustPermission("register")}.
Finally, if the name argument is null, another
MBeanPermission check is made using the
ObjectName returned by {@link
MBeanRegistration#preRegister MBeanRegistration.preRegister}.
For the createMBean methods, the caller's
permissions must imply the permissions needed by the equivalent
instantiate followed by
registerMBean .
For the {@link #unregisterMBean unregisterMBean} method,
the caller's permissions must imply {@link
MBeanPermission#MBeanPermission(String,String,ObjectName,String)
MBeanPermission(className, null, name, "unregisterMBean")}.
|
Methods Summary |
---|
public void | addNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)Adds a listener to a registered MBean.
A notification emitted by the MBean will be forwarded by the
MBeanServer to the listener. If the source of the notification
is a reference to the MBean object, the MBean server will replace it
by the MBean's ObjectName. Otherwise the source is unchanged.
| public void | addNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener, javax.management.NotificationFilter filter, java.lang.Object handback)Adds a listener to a registered MBean.
A notification emitted by the MBean will be forwarded by the
MBeanServer to the listener. If the source of the notification
is a reference to the MBean object, the MBean server will replace it
by the 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.
| public javax.management.ObjectInstance | createMBean(java.lang.String className, javax.management.ObjectName name)Instantiates and registers an MBean in the MBean server. The
MBean server will use its {@link
javax.management.loading.ClassLoaderRepository 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 {@link
javax.management.MBeanRegistration MBeanRegistration} interface
and returning the name from the {@link
MBeanRegistration#preRegister preRegister} method.
This method is equivalent to {@link
#createMBean(String,ObjectName,Object[],String[])
createMBean(className, name, (Object[]) null, (String[])
null)}.
| public javax.management.ObjectInstance | createMBean(java.lang.String className, javax.management.ObjectName name, javax.management.ObjectName loaderName)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 {@link
javax.management.MBeanRegistration MBeanRegistration} interface
and returning the name from the {@link
MBeanRegistration#preRegister preRegister} method.
This method is equivalent to {@link
#createMBean(String,ObjectName,ObjectName,Object[],String[])
createMBean(className, name, loaderName, (Object[]) null,
(String[]) null)}.
| public javax.management.ObjectInstance | createMBean(java.lang.String className, javax.management.ObjectName name, java.lang.Object[] params, java.lang.String[] signature)Instantiates and registers an MBean in the MBean server. The
MBean server will use its {@link
javax.management.loading.ClassLoaderRepository 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 {@link
javax.management.MBeanRegistration MBeanRegistration} interface
and returning the name from the {@link
MBeanRegistration#preRegister preRegister} method.
| public javax.management.ObjectInstance | createMBean(java.lang.String className, javax.management.ObjectName name, javax.management.ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature)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
{@link javax.management.MBeanRegistration MBeanRegistration}
interface and returning the name from the {@link
MBeanRegistration#preRegister preRegister} method.
| public java.io.ObjectInputStream | deserialize(javax.management.ObjectName name, byte[] data)De-serializes a byte array in the context of the class loader
of an MBean.
| public java.io.ObjectInputStream | deserialize(java.lang.String className, byte[] data)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 {@link
javax.management.loading.ClassLoaderRepository Class Loader
Repository}. The resultant class's class loader is the one to
use.
| public java.io.ObjectInputStream | deserialize(java.lang.String className, javax.management.ObjectName loaderName, byte[] data)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.
| public java.lang.Object | getAttribute(javax.management.ObjectName name, java.lang.String attribute)Gets the value of a specific attribute of a named MBean. The MBean
is identified by its object name.
| public javax.management.AttributeList | getAttributes(javax.management.ObjectName name, java.lang.String[] attributes)Gets the values of several attributes of a named MBean. The MBean
is identified by its object name.
| public java.lang.ClassLoader | getClassLoader(javax.management.ObjectName loaderName)Return the named {@link java.lang.ClassLoader}.
| public java.lang.ClassLoader | getClassLoaderFor(javax.management.ObjectName mbeanName)Return the {@link java.lang.ClassLoader} that was used for
loading the class of the named MBean.
| public javax.management.loading.ClassLoaderRepository | getClassLoaderRepository()Return the ClassLoaderRepository for this MBeanServer.
| public java.lang.String | getDefaultDomain()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.
| public java.lang.String[] | getDomains()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
{@link ObjectName#getDomain() getDomain()} is equal to that
string. The order of strings within the returned array is
not defined.
| public java.lang.Integer | getMBeanCount()Returns the number of MBeans registered in the MBean server.
| public javax.management.MBeanInfo | getMBeanInfo(javax.management.ObjectName name)This method discovers the attributes and operations that an
MBean exposes for management.
| public javax.management.ObjectInstance | getObjectInstance(javax.management.ObjectName name)Gets the ObjectInstance for a given MBean
registered with the MBean server.
| public java.lang.Object | instantiate(java.lang.String className)Instantiates an object using the list of all class loaders
registered in the MBean server's {@link
javax.management.loading.ClassLoaderRepository 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 {@link
#instantiate(String,Object[],String[])
instantiate(className, (Object[]) null, (String[]) null)}.
| public java.lang.Object | instantiate(java.lang.String className, javax.management.ObjectName loaderName)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 {@link
#instantiate(String,ObjectName,Object[],String[])
instantiate(className, loaderName, (Object[]) null, (String[])
null)}.
| public 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 {@link
javax.management.loading.ClassLoaderRepository 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.
| public java.lang.Object | instantiate(java.lang.String className, javax.management.ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature)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.
| public java.lang.Object | invoke(javax.management.ObjectName name, java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature)Invokes an operation on an MBean.
| public boolean | isInstanceOf(javax.management.ObjectName name, java.lang.String className)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 {@link InstanceNotFoundException}.
Otherwise, let
X be the MBean named by name ,
L be the ClassLoader of X,
N be the class name in X's {@link 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.
| public boolean | isRegistered(javax.management.ObjectName name)Checks whether an MBean, identified by its object name, is
already registered with the MBean server.
| public java.util.Set | queryMBeans(javax.management.ObjectName name, javax.management.QueryExp query)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.
| public java.util.Set | queryNames(javax.management.ObjectName name, javax.management.QueryExp query)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.
| public javax.management.ObjectInstance | registerMBean(java.lang.Object object, javax.management.ObjectName name)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 {@link
javax.management.MBeanRegistration MBeanRegistration} interface
and returning the name from the {@link
MBeanRegistration#preRegister preRegister} method.
| public void | removeNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener)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.
| public void | removeNotificationListener(javax.management.ObjectName name, javax.management.ObjectName listener, javax.management.NotificationFilter filter, java.lang.Object handback)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.
| public void | removeNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener)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.
| public void | removeNotificationListener(javax.management.ObjectName name, javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)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.
| public void | setAttribute(javax.management.ObjectName name, javax.management.Attribute attribute)Sets the value of a specific attribute of a named MBean. The MBean
is identified by its object name.
| public javax.management.AttributeList | setAttributes(javax.management.ObjectName name, javax.management.AttributeList attributes)Sets the values of several attributes of a named MBean. The MBean is
identified by its object name.
| public void | unregisterMBean(javax.management.ObjectName name)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.
|
|