com.sun.jdmk.interceptor
Class CompatibleMBeanInterceptor

java.lang.Object
  com.sun.jdmk.interceptor.CompatibleMBeanInterceptor

All Implemented Interfaces:

MBeanServerInterceptor, MBeanInterceptor, NotificationRegistration, ProxyHandler

public class CompatibleMBeanInterceptor
extends Object
implements MBeanServerInterceptor

An MBeanServerInterceptor that forwards every request unchanged to an MBeanInterceptor. This class is useful to transform an MBeanInterceptor into an MBeanServerInterceptor.

Since:

Java DMK 5.1

Constructor Summary

CompatibleMBeanInterceptor(MBeanInterceptor inter)
Create a new CompatibleMBeanInterceptor that forwards its requests to a MBeanInterceptor.

Method Summary

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, Object[] params, String[] signature) 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.
ClassLoader	getMBeanClassLoader(ObjectName name) Return the ClassLoader that was used for loading the class of the named MBean.
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.
MBeanInterceptor	getNextInterceptor() Return the MBeanInterceptor to which requests will be forwarded.
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	queryMBeans(ObjectName name, QueryExp query) Gets MBeans controlled by the MBean server.
Set	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, 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	removeNotificationListener(ObjectName name, ObjectName listener) Removes a listener from a registered MBean.
void	removeNotificationListener(ObjectName name, ObjectName 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompatibleMBeanInterceptor

public CompatibleMBeanInterceptor(MBeanInterceptor inter)

Create a new CompatibleMBeanInterceptor that forwards its requests to a MBeanInterceptor.

Method Detail

getNextInterceptor

public MBeanInterceptor getNextInterceptor()

Return the MBeanInterceptor to which requests will be forwarded.

Returns:

The wrapped MBeanInterceptor in the chain.

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name,
                                  Object[] params,
                                  String[] signature)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException

Description copied from interface: MBeanInterceptor

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.

Specified by:

createMBean in interface MBeanInterceptor

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:

ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.

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.

MBeanException - The constructor of the MBean has thrown an exception

NotCompliantMBeanException

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name,
                                  ObjectName loaderName,
                                  Object[] params,
                                  String[] signature)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException,
                                  InstanceNotFoundException

Description copied from interface: MBeanInterceptor

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.

Specified by:

createMBean in interface MBeanInterceptor

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:

ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.

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.

MBeanException - The constructor of the MBean has thrown an exception

InstanceNotFoundException - The specified class loader is not registered in the MBean server.

NotCompliantMBeanException

registerMBean

public ObjectInstance registerMBean(Object object,
                                    ObjectName name)
                             throws InstanceAlreadyExistsException,
                                    MBeanRegistrationException,
                                    NotCompliantMBeanException

Description copied from interface: MBeanInterceptor

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.

Specified by:

registerMBean in interface MBeanInterceptor

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

unregisterMBean

public void unregisterMBean(ObjectName name)
                     throws InstanceNotFoundException,
                            MBeanRegistrationException

Description copied from interface: MBeanInterceptor

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.

Specified by:

unregisterMBean in interface MBeanInterceptor

Specified by:

unregisterMBean in interface ProxyHandler

Parameters:

name - The object name of the MBean to be unregistered.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

MBeanRegistrationException - The preDeregister ((MBeanRegistration interface) method of the MBean has thrown an exception.

getObjectInstance

public ObjectInstance getObjectInstance(ObjectName name)
                                 throws InstanceNotFoundException

Description copied from interface: MBeanInterceptor

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

Specified by:

getObjectInstance in interface MBeanInterceptor

Parameters:

name - The object name of the MBean.

Returns:

The ObjectInstance associated to the MBean specified by name.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

queryMBeans

public Set queryMBeans(ObjectName name,
                       QueryExp query)

Description copied from interface: MBeanInterceptor

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.

Specified by:

queryMBeans in interface MBeanInterceptor

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.

queryNames

public Set queryNames(ObjectName name,
                      QueryExp query)

Description copied from interface: MBeanInterceptor

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.

Specified by:

queryNames in interface MBeanInterceptor

Parameters:

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.

Returns:

A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.

isRegistered

public boolean isRegistered(ObjectName name)

Description copied from interface: MBeanInterceptor

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

Specified by:

isRegistered in interface MBeanInterceptor

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.

getMBeanCount

public Integer getMBeanCount()

Description copied from interface: MBeanInterceptor

Returns the number of MBeans registered in the MBean server.

Specified by:

getMBeanCount in interface MBeanInterceptor

getAttribute

public Object getAttribute(ObjectName name,
                           String attribute)
                    throws MBeanException,
                           AttributeNotFoundException,
                           InstanceNotFoundException,
                           ReflectionException

Description copied from interface: MBeanInterceptor

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

Specified by:

getAttribute in interface MBeanInterceptor

Specified by:

getAttribute in interface ProxyHandler

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:

MBeanException - Wraps an exception thrown by the MBean's getter.

AttributeNotFoundException - The attribute specified is not accessible in the MBean.

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

ReflectionException - Wraps a java.lang.Exception thrown when trying to invoke the setter.

getAttributes

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

Description copied from interface: MBeanInterceptor

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

Specified by:

getAttributes in interface MBeanInterceptor

Specified by:

getAttributes in interface ProxyHandler

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 - The MBean specified is not registered in the MBean server.

ReflectionException - An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.

setAttribute

public void setAttribute(ObjectName name,
                         Attribute attribute)
                  throws InstanceNotFoundException,
                         AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException

Description copied from interface: MBeanInterceptor

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

Specified by:

setAttribute in interface MBeanInterceptor

Specified by:

setAttribute in interface ProxyHandler

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:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

AttributeNotFoundException - The attribute specified is not accessible in the MBean.

InvalidAttributeValueException - The value specified for the attribute is not valid.

MBeanException - Wraps an exception thrown by the MBean's setter.

ReflectionException - Wraps a java.lang.Exception thrown when trying to invoke the setter.

setAttributes

public AttributeList setAttributes(ObjectName name,
                                   AttributeList attributes)
                            throws InstanceNotFoundException,
                                   ReflectionException

Description copied from interface: MBeanInterceptor

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

Specified by:

setAttributes in interface MBeanInterceptor

Specified by:

setAttributes in interface ProxyHandler

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 - The MBean specified is not registered in the MBean server.

ReflectionException - An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.

invoke

public Object invoke(ObjectName name,
                     String operationName,
                     Object[] params,
                     String[] signature)
              throws InstanceNotFoundException,
                     MBeanException,
                     ReflectionException

Description copied from interface: MBeanInterceptor

Invokes an operation on an MBean.

Specified by:

invoke in interface MBeanInterceptor

Specified by:

invoke in interface ProxyHandler

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 of invoking the operation on the MBean specified.

Throws:

InstanceNotFoundException - The MBean specified is not registered in the MBean server.

MBeanException - Wraps an exception thrown by the MBean's invoked method.

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method.

getDefaultDomain

public String getDefaultDomain()

Description copied from interface: MBeanInterceptor

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.

Specified by:

getDefaultDomain in interface MBeanInterceptor

getDomains

public String[] getDomains()

Description copied from interface: MBeanServerInterceptor

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

Specified by:

getDomains in interface MBeanServerInterceptor

addNotificationListener

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

Description copied from interface: MBeanInterceptor

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.

Specified by:

addNotificationListener in interface MBeanInterceptor

Specified by:

addNotificationListener in interface NotificationRegistration

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 - The MBean name provided does not match any of the registered MBeans.

addNotificationListener

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

Description copied from interface: MBeanInterceptor

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.

Specified by:

addNotificationListener in interface MBeanInterceptor

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 - The MBean name of the notification listener or of the notification broadcaster does not match any of the registered MBeans.

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       ObjectName listener)
                                throws InstanceNotFoundException,
                                       ListenerNotFoundException

Description copied from interface: MBeanInterceptor

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.

Specified by:

removeNotificationListener in interface MBeanInterceptor

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 - The MBean name provided does not match any of the registered MBeans.

ListenerNotFoundException - The listener is not registered in the MBean.

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       ObjectName listener,
                                       NotificationFilter filter,
                                       Object handback)
                                throws InstanceNotFoundException,
                                       ListenerNotFoundException

Description copied from interface: MBeanServerInterceptor

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.

Specified by:

removeNotificationListener in interface MBeanServerInterceptor

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 - The MBean name provided does not match any of the registered MBeans.

ListenerNotFoundException - The listener is not registered in the MBean, or it is not registered with the given filter and handback.

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       NotificationListener listener)
                                throws InstanceNotFoundException,
                                       ListenerNotFoundException

Description copied from interface: MBeanInterceptor

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.

Specified by:

removeNotificationListener in interface MBeanInterceptor

Specified by:

removeNotificationListener in interface NotificationRegistration

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 - The MBean name provided does not match any of the registered MBeans.

ListenerNotFoundException - The listener is not registered in the MBean.

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       NotificationListener listener,
                                       NotificationFilter filter,
                                       Object handback)
                                throws InstanceNotFoundException,
                                       ListenerNotFoundException

Description copied from interface: MBeanServerInterceptor

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.

Specified by:

removeNotificationListener in interface MBeanServerInterceptor

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 - The MBean name provided does not match any of the registered MBeans.

ListenerNotFoundException - The listener is not registered in the MBean, or it is not registered with the given filter and handback.

getMBeanInfo

public MBeanInfo getMBeanInfo(ObjectName name)
                       throws InstanceNotFoundException,
                              IntrospectionException,
                              ReflectionException

Description copied from interface: MBeanInterceptor

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

Specified by:

getMBeanInfo in interface MBeanInterceptor

Specified by:

getMBeanInfo in interface ProxyHandler

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 - The MBean specified was not found.

IntrospectionException - An exception occurred during introspection.

ReflectionException - An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean.

isInstanceOf

public boolean isInstanceOf(ObjectName name,
                            String className)
                     throws InstanceNotFoundException

Description copied from interface: MBeanInterceptor

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

Specified by:

isInstanceOf in interface MBeanInterceptor

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 - The MBean specified is not registered in the MBean server.

getClassLoaderFor

public ClassLoader getClassLoaderFor(ObjectName mbeanName)
                              throws InstanceNotFoundException

Description copied from interface: MBeanServerInterceptor

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

Specified by:

getClassLoaderFor in interface MBeanServerInterceptor

Parameters:

mbeanName - The ObjectName of the MBean.

Returns:

The ClassLoader used for that MBean.

Throws:

InstanceNotFoundException - if the named MBean is not found.

getClassLoader

public ClassLoader getClassLoader(ObjectName loaderName)
                           throws InstanceNotFoundException

Description copied from interface: MBeanServerInterceptor

Return the named ClassLoader.

Specified by:

getClassLoader in interface MBeanServerInterceptor

Parameters:

loaderName - The ObjectName of the ClassLoader.

Returns:

The named ClassLoader.

Throws:

InstanceNotFoundException - if the named ClassLoader is not found.

getMBeanClassLoader

public final ClassLoader getMBeanClassLoader(ObjectName name)
                                      throws InstanceNotFoundException

Description copied from interface: MBeanServerInterceptor

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

Specified by:

getMBeanClassLoader in interface MBeanServerInterceptor

Specified by:

getMBeanClassLoader in interface MBeanInterceptor

Parameters:

name - The ObjectName of the MBean.

Returns:

The ClassLoader used for that MBean.

Throws:

InstanceNotFoundException - if the named MBean is not found.