com.sun.jdmk
Class MBeanServerForwarder

java.lang.Object
  |
  +--com.sun.jdmk.MBeanServerForwarder

All Implemented Interfaces:

MBeanServer, MBeanServerConnection

public class MBeanServerForwarder

extends Object

implements MBeanServer

An object of this class implements the MBeanServer interface and wraps another object that also implements that interface. Every method in MBeanServer is forwarded to the wrapped object.

This class is principally useful as the superclass for other wrapping classes that intercept some of the methods in MBeanServer and perform some action before forwarding to the wrapped object (or do not forward at all).

The wrapped object can be changed at any time. A frequent operation is to insert another MBeanServerForwarder between this one and the wrapped object. The idiom for that is:

 synchronized (mbeanServerForwarder) {
     MBeanServer oldmbs = mbeanServerForwarder.getMBeanServer();
     MBeanServer newmbs = new MyMBeanServerForwarder(oldmbs);
     mbeanServerForwarder.setMBeanServer(newmbs);
 }
 

The synchronized block ensures that information is not lost if two threads try to insert MBeanServerForwarders at the same time.

Constructor Summary

MBeanServerForwarder(MBeanServer mbs)
Make a new MBeanServerForwarder that forwards all requests from the MBeanServer interface to mbs.

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) This method calls createMBean(className, name, (Object[]) null, (String[]) null).
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) This method calls createMBean(className, name, loaderName, (Object[]) null, (String[]) null).
ObjectInstance	createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature) Instantiates and registers an MBean in the MBean server.
ObjectInputStream	deserialize(ObjectName name, byte[] data) De-serializes a byte array in the context of the class loader of an MBean.
ObjectInputStream	deserialize(String className, byte[] data) De-serializes a byte array in the context of a given MBean class loader.
ObjectInputStream	deserialize(String className, ObjectName loaderName, byte[] data) De-serializes a byte array in the context of a given MBean class loader.
Object	getAttribute(ObjectName name, String attribute) Gets the value of a specific attribute of a named MBean.
AttributeList	getAttributes(ObjectName name, String[] attributes) Gets 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.
ClassLoaderRepository	getClassLoaderRepository() Return the ClassLoaderRepository for this MBeanServer.
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.
MBeanServer	getMBeanServer() Return the wrapped MBeanServer to which all requests from the MBeanServer interface are forwarded.
ObjectInstance	getObjectInstance(ObjectName name) Gets the ObjectInstance for a given MBean registered with the MBean server.
Object	instantiate(String className) This method calls instantiate(className, (Object[]) null, (String[]) null).
Object	instantiate(String className, Object[] params, String[] signature) Instantiates an object using the list of all class loaders registered in the MBean server Class Loader Repository.
Object	instantiate(String className, ObjectName loaderName) This method calls instantiate(className, loaderName, (Object[]) null, (String[]) null).
Object	instantiate(String className, ObjectName loaderName, Object[] params, String[] signature) Instantiates an object.
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	setMBeanServer(MBeanServer mbs) Change the wrapped MBeanServer object to which all requests from the MBeanServer interface are forwarded.
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

MBeanServerForwarder

public MBeanServerForwarder(MBeanServer mbs)

Make a new MBeanServerForwarder that forwards all requests from the MBeanServer interface to mbs.

Parameters:

mbs - the wrapped MBeanServer to forward to.

Method Detail

getMBeanServer

public MBeanServer getMBeanServer()

Return the wrapped MBeanServer to which all requests from the MBeanServer interface are forwarded.

setMBeanServer

public void setMBeanServer(MBeanServer mbs)
                    throws IllegalArgumentException

Change the wrapped MBeanServer object to which all requests from the MBeanServer interface are forwarded. The old wrapped object is lost unless it was accessible by other means.

Parameters:

mbs - the new wrapped object.

Throws:

IllegalArgumentException - if mbs is null.

instantiate

public Object instantiate(String className)
                   throws ReflectionException,
                          MBeanException

This method calls instantiate(className, (Object[]) null, (String[]) null).

Specified by:

instantiate in interface MBeanServer

Parameters:

className - The class name of the object to be instantiated.

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception

instantiate

public Object instantiate(String className,
                          ObjectName loaderName)
                   throws ReflectionException,
                          MBeanException,
                          InstanceNotFoundException

This method calls instantiate(className, loaderName, (Object[]) null, (String[]) null).

Specified by:

instantiate in interface MBeanServer

Parameters:

className - The class name of the MBean to be instantiated.

loaderName - The object name of the class loader to be used.

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception.

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

instantiate

public Object instantiate(String className,
                          Object[] params,
                          String[] signature)
                   throws ReflectionException,
                          MBeanException

Description copied from interface: MBeanServer

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.

Specified by:

instantiate in interface MBeanServer

Parameters:

className - The class name of the object to be instantiated.

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:

The newly instantiated object.

Throws:

MBeanException - The constructor of the object has thrown an exception

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

instantiate

public Object instantiate(String className,
                          ObjectName loaderName,
                          Object[] params,
                          String[] signature)
                   throws ReflectionException,
                          MBeanException,
                          InstanceNotFoundException

Description copied from interface: MBeanServer

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.

Specified by:

instantiate in interface MBeanServer

Parameters:

className - The class name of the object to be instantiated.

params - An array containing the parameters of the constructor to be invoked.

signature - An array containing the signature of the constructor to be invoked.

loaderName - The object name of the class loader to be used.

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception

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

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException

This method calls createMBean(className, name, (Object[]) null, (String[]) null).

Specified by:

createMBean in interface MBeanServer

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:

MBeanException - The constructor of the MBean has thrown an exception

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

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.

NotCompliantMBeanException - This class is not a JMX compliant MBean

createMBean

public ObjectInstance createMBean(String className,
                                  ObjectName name,
                                  ObjectName loaderName)
                           throws ReflectionException,
                                  InstanceAlreadyExistsException,
                                  MBeanRegistrationException,
                                  MBeanException,
                                  NotCompliantMBeanException,
                                  InstanceNotFoundException

This method calls createMBean(className, name, loaderName, (Object[]) null, (String[]) null).

Specified by:

createMBean in interface MBeanServer

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 - The MBean is already under the control of the MBean server.

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

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

NotCompliantMBeanException - This class is not a JMX compliant MBean

MBeanException - The constructor of the MBean has thrown an exception

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

createMBean

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

Description copied from interface: MBeanServer

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 MBeanServer

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. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().

Throws:

NotCompliantMBeanException - This class is not a JMX compliant MBean

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.

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

MBeanException - The constructor of the MBean has thrown an exception

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

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 MBeanServer

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.

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:

MBeanException - The constructor of the MBean has thrown an exception

NotCompliantMBeanException - This class is not a JMX compliant MBean

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.

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

registerMBean

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

Description copied from interface: MBeanServer

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 MBeanServer

Parameters:

object - The MBean to be registered as an MBean.

name - The object name of the MBean. May be null.

Returns:

An ObjectInstance, containing the ObjectName and the Java class name of the newly registered MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().

Throws:

InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.

NotCompliantMBeanException - This object is not a JMX compliant MBean

MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.

unregisterMBean

public void unregisterMBean(ObjectName name)
                     throws InstanceNotFoundException,
                            MBeanRegistrationException

Description copied from interface: MBeanServer

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 MBeanServer

Parameters:

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

Throws:

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

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

getObjectInstance

public ObjectInstance getObjectInstance(ObjectName name)
                                 throws InstanceNotFoundException

Description copied from interface: MBeanServer

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

Specified by:

getObjectInstance in interface MBeanServer

Parameters:

name - The object name of the MBean.

Returns:

The ObjectInstance associated with the MBean specified by name. The contained ObjectName is name and the contained class name is getMBeanInfo(name).getClassName().

Throws:

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

queryMBeans

public Set queryMBeans(ObjectName name,
                       QueryExp query)

Description copied from interface: MBeanServer

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 MBeanServer

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 set is returned.

queryNames

public Set queryNames(ObjectName name,
                      QueryExp query)

Description copied from interface: MBeanServer

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 MBeanServer

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 set is returned.

isRegistered

public boolean isRegistered(ObjectName name)

Description copied from interface: MBeanServer

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

Specified by:

isRegistered in interface MBeanServer

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

Returns the number of MBeans registered in the MBean server.

Specified by:

getMBeanCount in interface MBeanServer

Returns:

the number of registered MBeans, wrapped in an Integer. If the caller's permissions are restricted, this number may be greater than the number of MBeans the caller can access.

getAttribute

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

Description copied from interface: MBeanServer

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

Specified by:

getAttribute in interface MBeanServer

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

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

See Also:

MBeanServer.setAttribute(javax.management.ObjectName, javax.management.Attribute)

getAttributes

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

Description copied from interface: MBeanServer

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

Specified by:

getAttributes in interface MBeanServer

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:

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

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

See Also:

MBeanServer.setAttributes(javax.management.ObjectName, javax.management.AttributeList)

setAttribute

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

Description copied from interface: MBeanServer

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

Specified by:

setAttribute in interface MBeanServer

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:

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

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

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

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

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

See Also:

MBeanServer.getAttribute(javax.management.ObjectName, java.lang.String)

setAttributes

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

Description copied from interface: MBeanServer

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

Specified by:

setAttributes in interface MBeanServer

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:

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

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

See Also:

MBeanServer.getAttributes(javax.management.ObjectName, java.lang.String[])

invoke

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

Description copied from interface: MBeanServer

Invokes an operation on an MBean.

Specified by:

invoke in interface MBeanServer

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

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

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

getDefaultDomain

public String getDefaultDomain()

Description copied from interface: MBeanServer

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 MBeanServer

Returns:

the default domain.

getDomains

public String[] getDomains()

Description copied from interface: 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.

Specified by:

getDomains in interface MBeanServer

Returns:

the list of domains.

addNotificationListener

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

Description copied from interface: MBeanServer

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.

Specified by:

addNotificationListener in interface MBeanServer

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.

See Also:

MBeanServer.removeNotificationListener(ObjectName, NotificationListener), MBeanServer.removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)

addNotificationListener

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

Description copied from interface: MBeanServer

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.

Specified by:

addNotificationListener in interface MBeanServer

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.

See Also:

MBeanServer.removeNotificationListener(ObjectName, ObjectName), MBeanServer.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)

removeNotificationListener

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

Description copied from interface: MBeanServer

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 MBeanServer

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:

ListenerNotFoundException - The listener is not registered in the MBean.

InstanceNotFoundException - The MBean name provided does not match any of the registered MBeans.

See Also:

MBeanServer.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)

removeNotificationListener

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

Description copied from interface: MBeanServer

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 MBeanServer

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:

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

InstanceNotFoundException - The MBean name provided does not match any of the registered MBeans.

See Also:

MBeanServer.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)

removeNotificationListener

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

Description copied from interface: MBeanServer

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 MBeanServer

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.

See Also:

MBeanServer.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)

removeNotificationListener

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

Description copied from interface: MBeanServer

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 MBeanServer

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:

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

InstanceNotFoundException - The MBean name provided does not match any of the registered MBeans.

See Also:

MBeanServer.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)

getMBeanInfo

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

Description copied from interface: MBeanServer

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

Specified by:

getMBeanInfo in interface MBeanServer

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:

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

InstanceNotFoundException - The MBean specified was not found.

IntrospectionException - An exception occured during introspection.

isInstanceOf

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

Description copied from interface: MBeanServer

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.

Specified by:

isInstanceOf in interface MBeanServer

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 according to the rules above, false otherwise.

Throws:

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

See Also:

Class.isAssignableFrom(Class)

deserialize

public ObjectInputStream deserialize(ObjectName name,
                                     byte[] data)
                              throws InstanceNotFoundException,
                                     OperationsException

Description copied from interface: MBeanServer

De-serializes a byte array in the context of the class loader of an MBean.

Specified by:

deserialize in interface MBeanServer

Parameters:

name - The name of the MBean whose class loader should be used for the de-serialization.

data - The byte array to be de-sererialized.

Returns:

The de-serialized object stream.

Throws:

OperationsException - Any of the usual Input/Output related exceptions.

InstanceNotFoundException - The MBean specified is not found.

deserialize

public ObjectInputStream deserialize(String className,
                                     byte[] data)
                              throws OperationsException,
                                     ReflectionException

Description copied from interface: MBeanServer

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.

Specified by:

deserialize in interface MBeanServer

Parameters:

className - The name of the class whose class loader should be used for the de-serialization.

data - The byte array to be de-sererialized.

Returns:

The de-serialized object stream.

Throws:

OperationsException - Any of the usual Input/Output related exceptions.

ReflectionException - The specified class could not be loaded by the class loader repository

deserialize

public ObjectInputStream deserialize(String className,
                                     ObjectName loaderName,
                                     byte[] data)
                              throws InstanceNotFoundException,
                                     OperationsException,
                                     ReflectionException

Description copied from interface: MBeanServer

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.

Specified by:

deserialize in interface MBeanServer

Parameters:

className - The name of the class whose class loader should be used for the de-serialization.

data - The byte array to be de-sererialized.

loaderName - The name of the class loader to be used for loading the specified class. If null, the MBean Server's class loader will be used.

Returns:

The de-serialized object stream.

Throws:

ReflectionException - The specified class could not be loaded by the specified class loader.

OperationsException - Any of the usual Input/Output related exceptions.

InstanceNotFoundException - The specified class loader MBean is not found.

getClassLoaderFor

public ClassLoader getClassLoaderFor(ObjectName mbeanName)
                              throws InstanceNotFoundException

Description copied from interface: MBeanServer

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

Specified by:

getClassLoaderFor in interface MBeanServer

Parameters:

mbeanName - The ObjectName of the MBean.

Returns:

The ClassLoader used for that MBean. If l is the MBean's actual ClassLoader, and r is the returned value, then either:

• r is identical to l; or
• the result of r.loadClass(s) is the same as l.loadClass(s) for any string s.

What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.

Throws:

InstanceNotFoundException - if the named MBean is not found.

getClassLoader

public ClassLoader getClassLoader(ObjectName loaderName)
                           throws InstanceNotFoundException

Description copied from interface: MBeanServer

Return the named ClassLoader.

Specified by:

getClassLoader in interface MBeanServer

Parameters:

loaderName - The ObjectName of the ClassLoader. May be null, in which case the MBean server's own ClassLoader is returned.

Returns:

The named ClassLoader. If l is the actual ClassLoader with that name, and r is the returned value, then either:

• r is identical to l; or
• the result of r.loadClass(s) is the same as l.loadClass(s) for any string s.

What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.

Throws:

InstanceNotFoundException - if the named ClassLoader is not found.

getClassLoaderRepository

public ClassLoaderRepository getClassLoaderRepository()

Description copied from interface: MBeanServer

Return the ClassLoaderRepository for this MBeanServer.

Specified by:

getClassLoaderRepository in interface MBeanServer

Returns:

The ClassLoaderRepository for this MBeanServer.