public class

DefaultMBeanServerInterceptor

extends Object
implements MBeanServerInterceptor
java.lang.Object
   ↳ com.sun.jmx.interceptor.DefaultMBeanServerInterceptor

Class Overview

This is the default class 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.

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 an 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.

Summary

Public Constructors
DefaultMBeanServerInterceptor(MBeanServer outer, MBeanServerDelegate delegate, MBeanInstantiator instantiator, Repository repository)
Creates a DefaultMBeanServerInterceptor with the specified repository instance.
Public Methods
void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)

Adds a listener to a registered MBean.

void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)

Adds a listener to a registered MBean.

ObjectInstance createMBean(String className, ObjectName name)

Instantiates and registers an MBean in the MBean server.

ObjectInstance createMBean(String className, ObjectName name, Object[] params, String[] signature)
Instantiates and registers an MBean in the MBean server.
ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName)

Instantiates and registers an MBean in the MBean server.

ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature)
Instantiates and registers an MBean in the MBean server.
Object getAttribute(ObjectName name, String attribute)
Gets the value of a specific attribute of a named MBean.
AttributeList getAttributes(ObjectName name, String[] attributes)
Enables the values of several attributes of a named MBean.
ClassLoader getClassLoader(ObjectName loaderName)

Return the named ClassLoader.

ClassLoader getClassLoaderFor(ObjectName mbeanName)

Return the ClassLoader that was used for loading the class of the named MBean.

String getDefaultDomain()
Returns the default domain used for naming the MBean.
String[] getDomains()
Returns the list of domains in which any MBean is currently registered.
Integer getMBeanCount()
Returns the number of MBeans registered in the MBean server.
MBeanInfo getMBeanInfo(ObjectName name)
This method discovers the attributes and operations that an MBean exposes for management.
ObjectInstance getObjectInstance(ObjectName name)
Gets the ObjectInstance for a given MBean registered with the MBean server.
Object invoke(ObjectName name, String operationName, Object[] params, String[] signature)
Invokes an operation on an MBean.
boolean isInstanceOf(ObjectName name, 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 MBean server.
Set<ObjectInstance> queryMBeans(ObjectName name, QueryExp query)
Gets MBeans controlled by the MBean server.
Set<ObjectName> queryNames(ObjectName name, QueryExp query)
Gets the names of MBeans controlled by the MBean server.
ObjectInstance registerMBean(Object object, ObjectName name)
Registers a pre-existing object as an MBean with the MBean server.
void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)

Removes a listener from a registered MBean.

void removeNotificationListener(ObjectName name, ObjectName listener)
Removes a listener from a registered MBean.
void removeNotificationListener(ObjectName name, NotificationListener listener)

Removes a listener from a registered MBean.

void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)

Removes a listener from a registered MBean.

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)
Unregisters an MBean from the MBean server.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sun.jmx.interceptor.MBeanServerInterceptor
From interface javax.management.MBeanServerConnection

Public Constructors

public DefaultMBeanServerInterceptor (MBeanServer outer, MBeanServerDelegate delegate, MBeanInstantiator instantiator, Repository repository)

Creates a DefaultMBeanServerInterceptor with the specified repository instance.

Do not forget to call initialize(outer,delegate) before using this object.

Parameters
outer A pointer to the MBeanServer object that must be passed to the MBeans when invoking their MBeanRegistration interface.
delegate A pointer to the MBeanServerDelegate associated with the new MBeanServer. The new MBeanServer must register this MBean in its MBean repository.
instantiator The MBeanInstantiator that will be used to instantiate MBeans and take care of class loading issues.
repository The repository to use for this MBeanServer.

Public Methods

public void addNotificationListener (ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)

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.

Parameters
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.
Throws
InstanceNotFoundException

public void addNotificationListener (ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)

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.

Parameters
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.
Throws
InstanceNotFoundException

public ObjectInstance createMBean (String className, ObjectName name)

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).

Parameters
className The class name of the MBean to be instantiated.
name The object name of the MBean. May be null.
Returns
  • An 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().
Throws
InstanceAlreadyExistsException
MBeanException
MBeanRegistrationException
NotCompliantMBeanException
ReflectionException

public ObjectInstance createMBean (String className, ObjectName name, Object[] params, String[] signature)

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.

Parameters
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.
Returns
  • An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean.
Throws
InstanceAlreadyExistsException
MBeanException
MBeanRegistrationException
NotCompliantMBeanException
ReflectionException

public ObjectInstance createMBean (String className, ObjectName name, 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 MBeanRegistration interface and returning the name from the preRegister method.

This method is equivalent to createMBean(className, name, loaderName, (Object[]) null, (String[]) null).

Parameters
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.
Returns
  • An 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().
Throws
InstanceAlreadyExistsException
InstanceNotFoundException
MBeanException
MBeanRegistrationException
NotCompliantMBeanException
ReflectionException

public ObjectInstance createMBean (String className, ObjectName name, ObjectName loaderName, Object[] params, 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 MBeanRegistration interface and returning the name from the preRegister method.

Parameters
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.
Returns
  • An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean.
Throws
InstanceAlreadyExistsException
InstanceNotFoundException
MBeanException
MBeanRegistrationException
NotCompliantMBeanException
ReflectionException

public Object getAttribute (ObjectName name, String attribute)

Gets the value of a specific attribute of a named MBean. The MBean is identified by its object name.

Parameters
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.
Returns
  • The value of the retrieved attribute.
Throws
AttributeNotFoundException
InstanceNotFoundException
MBeanException
ReflectionException

public AttributeList getAttributes (ObjectName name, String[] attributes)

Enables the values of several attributes of a named MBean. The MBean is identified by its object name.

Parameters
name The object name of the MBean from which the attributes are retrieved.
attributes A list of the attributes to be retrieved.
Returns
  • The list of the retrieved attributes.
Throws
InstanceNotFoundException
ReflectionException

public ClassLoader getClassLoader (ObjectName loaderName)

Return the named ClassLoader.

Parameters
loaderName The ObjectName of the ClassLoader.
Returns
  • The named ClassLoader.
Throws
InstanceNotFoundException if the named ClassLoader is not found.

public ClassLoader getClassLoaderFor (ObjectName mbeanName)

Return the ClassLoader that was used for loading the class of the named MBean.

Parameters
mbeanName The ObjectName of the MBean.
Returns
  • The ClassLoader used for that MBean.
Throws
InstanceNotFoundException if the named MBean is not found.

public 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.

Returns
  • the default domain.

public String[] getDomains ()

Returns the list of domains in which any MBean is currently registered.

Returns
  • the list of domains.

public Integer getMBeanCount ()

Returns the number of MBeans registered in the MBean server.

Returns
  • the number of MBeans registered.

public MBeanInfo getMBeanInfo (ObjectName name)

This method discovers the attributes and operations that an MBean exposes for management.

Parameters
name The name of the MBean to analyze
Returns
  • An instance of MBeanInfo allowing the retrieval of all attributes and operations of this MBean.
Throws
InstanceNotFoundException
IntrospectionException
ReflectionException

public ObjectInstance getObjectInstance (ObjectName name)

Gets the ObjectInstance for a given MBean registered with the MBean server.

Parameters
name The object name of the MBean.
Returns
  • The ObjectInstance associated to the MBean specified by name.
Throws
InstanceNotFoundException

public Object invoke (ObjectName name, String operationName, Object[] params, String[] signature)

Invokes an operation on an MBean.

Parameters
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
  • The object returned by the operation, which represents the result ofinvoking the operation on the MBean specified.
Throws
InstanceNotFoundException
MBeanException
ReflectionException

public boolean isInstanceOf (ObjectName name, String className)

Returns true if the MBean specified is an instance of the specified class, false otherwise.

Parameters
name The ObjectName of the MBean.
className The name of the class.
Returns
  • true if the MBean specified is an instance of the specified class, false otherwise.
Throws
InstanceNotFoundException

public boolean isRegistered (ObjectName name)

Checks whether an MBean, identified by its object name, is already registered with the MBean server.

Parameters
name The object name of the MBean to be checked.
Returns
  • True if the MBean is already registered in the MBean server, false otherwise.

public Set<ObjectInstance> queryMBeans (ObjectName name, 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.

Parameters
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.
Returns
  • A set containing the ObjectInstance objects for the selected MBeans. If no MBean satisfies the query an empty list is returned.

public Set<ObjectName> queryNames (ObjectName name, 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.

Parameters
name The object name pattern identifying the MBean names to be retrieved. If null oror 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.
Returns
  • A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.

public ObjectInstance registerMBean (Object object, 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 MBeanRegistration interface and returning the name from the preRegister method.

Parameters
object The MBean to be registered as an MBean.
name The object name of the MBean. May be null.
Returns
  • The ObjectInstance for the MBean that has been registered.
Throws
InstanceAlreadyExistsException
MBeanRegistrationException
NotCompliantMBeanException

public void removeNotificationListener (ObjectName name, ObjectName listener, NotificationFilter filter, 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.

Parameters
name The name of the MBean on which the listener should be removed.
listener A listener that was previously added to this MBean.
filter The filter that was specified when the listener was added.
handback The handback that was specified when the listener was added.
Throws
InstanceNotFoundException
ListenerNotFoundException

public void removeNotificationListener (ObjectName name, 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.

Parameters
name The name of the MBean on which the listener should be removed.
listener The object name of the listener to be removed.
Throws
InstanceNotFoundException
ListenerNotFoundException

public void removeNotificationListener (ObjectName name, 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.

Parameters
name The name of the MBean on which the listener should be removed.
listener The listener object which will handle the notifications emitted by the registered MBean.
Throws
InstanceNotFoundException
ListenerNotFoundException

public void removeNotificationListener (ObjectName name, NotificationListener listener, NotificationFilter filter, 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.

Parameters
name The name of the MBean on which the listener should be removed.
listener A listener that was previously added to this MBean.
filter The filter that was specified when the listener was added.
handback The handback that was specified when the listener was added.
Throws
InstanceNotFoundException
ListenerNotFoundException

public void setAttribute (ObjectName name, Attribute attribute)

Sets the value of a specific attribute of a named MBean. The MBean is identified by its object name.

Parameters
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.
Throws
AttributeNotFoundException
InstanceNotFoundException
InvalidAttributeValueException
MBeanException
ReflectionException

public AttributeList setAttributes (ObjectName name, AttributeList attributes)

Sets the values of several attributes of a named MBean. The MBean is identified by its object name.

Parameters
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.
Returns
  • The list of attributes that were set, with their new values.
Throws
InstanceNotFoundException
ReflectionException

public void unregisterMBean (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.

Parameters
name The object name of the MBean to be unregistered.
Throws
InstanceNotFoundException
MBeanRegistrationException