/*
* Copyright (c) 2002, 2005, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.jmx.interceptor;
import java.util.Set;
// RI import
import javax.management.DynamicMBean;
import javax.management.AttributeNotFoundException;
import javax.management.MBeanException;
import javax.management.ReflectionException;
import javax.management.MBeanAttributeInfo;
import javax.management.MBeanInfo;
import javax.management.QueryExp;
import javax.management.NotificationListener;
import javax.management.NotificationFilter;
import javax.management.ListenerNotFoundException;
import javax.management.IntrospectionException;
import javax.management.OperationsException;
import javax.management.MBeanNotificationInfo;
import javax.management.JMRuntimeException;
import javax.management.InstanceNotFoundException;
import javax.management.NotCompliantMBeanException;
import javax.management.MBeanRegistrationException;
import javax.management.InstanceAlreadyExistsException;
import javax.management.InvalidAttributeValueException;
import javax.management.ObjectName;
import javax.management.ObjectInstance;
import javax.management.Attribute;
import javax.management.AttributeList;
import javax.management.RuntimeOperationsException;
import javax.management.MBeanServerConnection;
import javax.management.MBeanServerDelegate;
import javax.management.loading.ClassLoaderRepository;
This interface specifies the behavior to be implemented by an MBean Server Interceptor. An MBean Server Interceptor has essentially the same interface as an MBean Server. An MBean Server forwards received requests to its default interceptor, which may handle them itself or forward them to other interceptors. The default interceptor may be changed via the SunJmxMBeanServer.setMBeanServerInterceptor
method.
The initial default interceptor provides the standard MBean Server behavior. It handles a collection of named MBeans, each represented by a Java object. A replacement default interceptor may build on this behavior, for instance by adding logging or security checks, before forwarding requests to the initial default interceptor. Or, it may route each request to one of a number of sub-interceptors, for instance based on the ObjectName
in the request.
An interceptor, default or not, need not implement MBeans as
Java objects, in the way that the initial default interceptor does.
It may instead implement virtual MBeans, which do not
exist as Java objects when they are not in use. For example, these
MBeans could be implemented by forwarding requests to a database,
or to a remote MBean server, or by performing system calls to query
or modify system resources.
Since: 1.5
/**
* <p>This interface specifies the behavior to be implemented by an
* MBean Server Interceptor. An MBean Server Interceptor has
* essentially the same interface as an MBean Server. An MBean Server
* forwards received requests to its default interceptor, which may
* handle them itself or forward them to other interceptors. The
* default interceptor may be changed via the {@link
* com.sun.jmx.mbeanserver.SunJmxMBeanServer#setMBeanServerInterceptor}
* method.</p>
*
* <p>The initial default interceptor provides the standard MBean
* Server behavior. It handles a collection of named MBeans, each
* represented by a Java object. A replacement default interceptor
* may build on this behavior, for instance by adding logging or
* security checks, before forwarding requests to the initial default
* interceptor. Or, it may route each request to one of a number of
* sub-interceptors, for instance based on the {@link ObjectName} in
* the request.</p>
*
* <p>An interceptor, default or not, need not implement MBeans as
* Java objects, in the way that the initial default interceptor does.
* It may instead implement <em>virtual MBeans</em>, which do not
* exist as Java objects when they are not in use. For example, these
* MBeans could be implemented by forwarding requests to a database,
* or to a remote MBean server, or by performing system calls to query
* or modify system resources.</p>
*
* @since 1.5
*/
public interface MBeanServerInterceptor extends MBeanServerConnection {
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. Params: - 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.
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
- RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The className
passed in parameter is null, the ObjectName
passed
in parameter contains a pattern or no ObjectName
is specified for the MBean.
Returns: An ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean.
/**
* Instantiates and registers an MBean in the MBean server. The
* MBean server will use its {@link
* javax.management.loading.ClassLoaderRepository Default Loader
* Repository} to load the class of the MBean. An object name is
* associated to the MBean. If the object name given is null, the
* MBean must provide its own name by implementing the {@link
* javax.management.MBeanRegistration MBeanRegistration} interface
* and returning the name from the {@link
* javax.management.MBeanRegistration#preRegister preRegister} method.
*
* @param className The class name of the MBean to be instantiated.
* @param name The object name of the MBean. May be null.
* @param params An array containing the parameters of the
* constructor to be invoked.
* @param signature An array containing the signature of the
* constructor to be invoked.
*
* @return An <CODE>ObjectInstance</CODE>, containing the
* <CODE>ObjectName</CODE> and the Java class name of the newly
* instantiated MBean.
*
* @exception ReflectionException Wraps a
* <CODE>java.lang.ClassNotFoundException</CODE> or a
* <CODE>java.lang.Exception</CODE> that occurred when trying to
* invoke the MBean's constructor.
* @exception InstanceAlreadyExistsException The MBean is already
* under the control of the MBean server.
* @exception MBeanRegistrationException The
* <CODE>preRegister</CODE> (<CODE>MBeanRegistration</CODE>
* interface) method of the MBean has thrown an exception. The
* MBean will not be registered.
* @exception MBeanException The constructor of the MBean has
* thrown an exception
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The className
* passed in parameter is null, the <CODE>ObjectName</CODE> passed
* in parameter contains a pattern or no <CODE>ObjectName</CODE>
* is specified for the MBean.
*/
public ObjectInstance createMBean(String className, ObjectName name,
Object params[], String signature[])
throws ReflectionException, InstanceAlreadyExistsException,
MBeanRegistrationException, MBeanException,
NotCompliantMBeanException;
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. Params: - 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.
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.
- RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The className
passed in parameter is null, the ObjectName
passed
in parameter contains a pattern or no ObjectName
is specified for the MBean.
Returns: An ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated MBean.
/**
* Instantiates and registers an MBean in the MBean server. The
* class loader to be used is identified by its object name. An
* object name is associated to the MBean. If the object name of
* the loader is not specified, the ClassLoader that loaded the
* MBean server will be used. If the MBean object name given is
* null, the MBean must provide its own name by implementing the
* {@link javax.management.MBeanRegistration MBeanRegistration}
* interface and returning the name from the {@link
* javax.management.MBeanRegistration#preRegister preRegister} method.
*
* @param className The class name of the MBean to be instantiated.
* @param name The object name of the MBean. May be null.
* @param params An array containing the parameters of the
* constructor to be invoked.
* @param signature An array containing the signature of the
* constructor to be invoked.
* @param loaderName The object name of the class loader to be used.
*
* @return An <CODE>ObjectInstance</CODE>, containing the
* <CODE>ObjectName</CODE> and the Java class name of the newly
* instantiated MBean.
*
* @exception ReflectionException Wraps a
* <CODE>java.lang.ClassNotFoundException</CODE> or a
* <CODE>java.lang.Exception</CODE> that occurred when trying to
* invoke the MBean's constructor.
* @exception InstanceAlreadyExistsException The MBean is already
* under the control of the MBean server.
* @exception MBeanRegistrationException The
* <CODE>preRegister</CODE> (<CODE>MBeanRegistration</CODE>
* interface) method of the MBean has thrown an exception. The
* MBean will not be registered.
* @exception MBeanException The constructor of the MBean has
* thrown an exception
* @exception InstanceNotFoundException The specified class loader
* is not registered in the MBean server.
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The className
* passed in parameter is null, the <CODE>ObjectName</CODE> passed
* in parameter contains a pattern or no <CODE>ObjectName</CODE>
* is specified for the MBean.
*
*/
public ObjectInstance createMBean(String className, ObjectName name,
ObjectName loaderName, Object params[],
String signature[])
throws ReflectionException, InstanceAlreadyExistsException,
MBeanRegistrationException, MBeanException,
NotCompliantMBeanException, InstanceNotFoundException;
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. Params: - object – The MBean to be registered as an MBean.
- name – The object name of the MBean. May be null.
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
- RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The object
passed in parameter is null or no object name is specified.
Returns: The ObjectInstance
for the MBean that has
been registered.
/**
* Registers a pre-existing object as an MBean with the MBean
* server. If the object name given is null, the MBean must
* provide its own name by implementing the {@link
* javax.management.MBeanRegistration MBeanRegistration} interface
* and returning the name from the {@link
* javax.management.MBeanRegistration#preRegister preRegister} method.
*
* @param object The MBean to be registered as an MBean.
* @param name The object name of the MBean. May be null.
*
* @return The <CODE>ObjectInstance</CODE> for the MBean that has
* been registered.
*
* @exception InstanceAlreadyExistsException The MBean is already
* under the control of the MBean server.
* @exception MBeanRegistrationException The
* <CODE>preRegister</CODE> (<CODE>MBeanRegistration</CODE>
* interface) method of the MBean has thrown an exception. The
* MBean will not be registered.
* @exception NotCompliantMBeanException This object is not a JMX
* compliant MBean
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* passed in parameter is null or no object name is specified.
*/
public ObjectInstance registerMBean(Object object, ObjectName name)
throws InstanceAlreadyExistsException, MBeanRegistrationException,
NotCompliantMBeanException;
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.
Params: - 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. - RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The object name in parameter is null or the MBean you are when trying to unregister is the
MBeanServerDelegate
MBean.
/**
* 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.
*
* @param name The object name of the MBean to be unregistered.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
* @exception MBeanRegistrationException The preDeregister
* ((<CODE>MBeanRegistration</CODE> interface) method of the MBean
* has thrown an exception.
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* name in parameter is null or the MBean you are when trying to
* unregister is the {@link javax.management.MBeanServerDelegate
* MBeanServerDelegate} MBean.
*
*/
public void unregisterMBean(ObjectName name)
throws InstanceNotFoundException, MBeanRegistrationException;
Gets the ObjectInstance
for a given MBean
registered with the MBean server.
Params: - name – The object name of the MBean.
Throws: - InstanceNotFoundException – The MBean specified is not
registered in the MBean server.
Returns: The ObjectInstance
associated to the MBean
specified by name.
/**
* Gets the <CODE>ObjectInstance</CODE> for a given MBean
* registered with the MBean server.
*
* @param name The object name of the MBean.
*
* @return The <CODE>ObjectInstance</CODE> associated to the MBean
* specified by <VAR>name</VAR>.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
*/
public ObjectInstance getObjectInstance(ObjectName name)
throws InstanceNotFoundException;
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.
Params: - 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.
/**
* 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
* <CODE>ObjectName</CODE> 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
* <CODE>ObjectInstance</CODE> objects (containing the
* <CODE>ObjectName</CODE> and the Java Class name) for the
* selected MBeans.
*
* @param 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.
* @param query The query expression to be applied for selecting
* MBeans. If null no query expression will be applied for
* selecting MBeans.
*
* @return A set containing the <CODE>ObjectInstance</CODE>
* objects for the selected MBeans. If no MBean satisfies the
* query an empty list is returned.
*/
public Set<ObjectInstance> queryMBeans(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.
Params: - 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.
/**
* 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 <CODE>ObjectName</CODE> 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.
*
* @param 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.
* @param query The query expression to be applied for selecting
* MBeans. If null no query expression will be applied for
* selecting MBeans.
*
* @return A set containing the ObjectNames for the MBeans
* selected. If no MBean satisfies the query, an empty list is
* returned.
*/
public Set<ObjectName> queryNames(ObjectName name, QueryExp query);
Checks whether an MBean, identified by its object name, is
already registered with the MBean server.
Params: - name – The object name of the MBean to be checked.
Throws: - RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The object
name in parameter is null.
Returns: True if the MBean is already registered in the MBean
server, false otherwise.
/**
* Checks whether an MBean, identified by its object name, is
* already registered with the MBean server.
*
* @param name The object name of the MBean to be checked.
*
* @return True if the MBean is already registered in the MBean
* server, false otherwise.
*
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* name in parameter is null.
*/
public boolean isRegistered(ObjectName name);
Returns the number of MBeans registered in the MBean server.
/**
* Returns the number of MBeans registered in the MBean server.
*/
public Integer getMBeanCount();
Gets the value of a specific attribute of a named MBean. The MBean
is identified by its object name.
Params: - 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.
Throws: - AttributeNotFoundException – The attribute specified
is not accessible in the MBean.
- MBeanException – Wraps an exception thrown by the
MBean's getter.
- InstanceNotFoundException – The MBean specified is not
registered in the MBean server.
- ReflectionException – Wraps a
java.lang.Exception
thrown when trying to invoke
the setter. - RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The object
name in parameter is null or the attribute in parameter is
null.
Returns: The value of the retrieved attribute.
/**
* Gets the value of a specific attribute of a named MBean. The MBean
* is identified by its object name.
*
* @param name The object name of the MBean from which the
* attribute is to be retrieved.
* @param attribute A String specifying the name of the attribute
* to be retrieved.
*
* @return The value of the retrieved attribute.
*
* @exception AttributeNotFoundException The attribute specified
* is not accessible in the MBean.
* @exception MBeanException Wraps an exception thrown by the
* MBean's getter.
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
* @exception ReflectionException Wraps a
* <CODE>java.lang.Exception</CODE> thrown when trying to invoke
* the setter.
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* name in parameter is null or the attribute in parameter is
* null.
*/
public Object getAttribute(ObjectName name, String attribute)
throws MBeanException, AttributeNotFoundException,
InstanceNotFoundException, ReflectionException;
Enables the values of several attributes of a named MBean. The MBean
is identified by its object name.
Params: - name – The object name of the MBean from which the
attributes are retrieved.
- attributes – A list of the attributes to be retrieved.
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.
- RuntimeOperationsException – Wrap a
java.lang.IllegalArgumentException
: The object
name in parameter is null or attributes in parameter is null.
Returns: The list of the retrieved attributes.
/**
* Enables the values of several attributes of a named MBean. The MBean
* is identified by its object name.
*
* @param name The object name of the MBean from which the
* attributes are retrieved.
* @param attributes A list of the attributes to be retrieved.
*
* @return The list of the retrieved attributes.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
* @exception ReflectionException An exception occurred when
* trying to invoke the getAttributes method of a Dynamic MBean.
* @exception RuntimeOperationsException Wrap a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* name in parameter is null or attributes in parameter is null.
*/
public AttributeList getAttributes(ObjectName name, String[] attributes)
throws InstanceNotFoundException, ReflectionException;
Sets the value of a specific attribute of a named MBean. The MBean
is identified by its object name.
Params: - 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. - RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The object
name in parameter is null or the attribute in parameter is
null.
/**
* Sets the value of a specific attribute of a named MBean. The MBean
* is identified by its object name.
*
* @param name The name of the MBean within which the attribute is
* to be set.
* @param attribute The identification of the attribute to be set
* and the value it is to be set to.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
* @exception AttributeNotFoundException The attribute specified
* is not accessible in the MBean.
* @exception InvalidAttributeValueException The value specified
* for the attribute is not valid.
* @exception MBeanException Wraps an exception thrown by the
* MBean's setter.
* @exception ReflectionException Wraps a
* <CODE>java.lang.Exception</CODE> thrown when trying to invoke
* the setter.
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* name in parameter is null or the attribute in parameter is
* null.
*/
public void setAttribute(ObjectName name, Attribute attribute)
throws InstanceNotFoundException, AttributeNotFoundException,
InvalidAttributeValueException, MBeanException,
ReflectionException;
Sets the values of several attributes of a named MBean. The MBean is
identified by its object name.
Params: - 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.
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.
- RuntimeOperationsException – Wraps a
java.lang.IllegalArgumentException
: The object
name in parameter is null or attributes in parameter is null.
Returns: The list of attributes that were set, with their new
values.
/**
* Sets the values of several attributes of a named MBean. The MBean is
* identified by its object name.
*
* @param name The object name of the MBean within which the
* attributes are to be set.
* @param attributes A list of attributes: The identification of
* the attributes to be set and the values they are to be set to.
*
* @return The list of attributes that were set, with their new
* values.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
* @exception ReflectionException An exception occurred when
* trying to invoke the getAttributes method of a Dynamic MBean.
* @exception RuntimeOperationsException Wraps a
* <CODE>java.lang.IllegalArgumentException</CODE>: The object
* name in parameter is null or attributes in parameter is null.
*/
public AttributeList setAttributes(ObjectName name,
AttributeList attributes)
throws InstanceNotFoundException, ReflectionException;
Invokes an operation on an MBean.
Params: - 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.
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.
Returns: The object returned by the operation, which represents
the result ofinvoking the operation on the MBean specified.
/**
* Invokes an operation on an MBean.
*
* @param name The object name of the MBean on which the method is
* to be invoked.
* @param operationName The name of the operation to be invoked.
* @param params An array containing the parameters to be set when
* the operation is invoked
* @param 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.
*
* @return The object returned by the operation, which represents
* the result ofinvoking the operation on the MBean specified.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
* @exception MBeanException Wraps an exception thrown by the
* MBean's invoked method.
* @exception ReflectionException Wraps a
* <CODE>java.lang.Exception</CODE> thrown while trying to invoke
* the method.
*/
public Object invoke(ObjectName name, String operationName,
Object params[], String signature[])
throws InstanceNotFoundException, MBeanException,
ReflectionException;
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 used for naming the MBean.
* The default domain name is used as the domain part in the ObjectName
* of MBeans if no domain is specified by the user.
*/
public String getDefaultDomain();
Returns the list of domains in which any MBean is currently
registered.
/**
* Returns the list of domains in which any MBean is currently
* registered.
*/
public String[] getDomains();
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.
Params: - 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.
/**
* <p>Adds a listener to a registered MBean.</p>
*
* <P> 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.
*
* @param name The name of the MBean on which the listener should
* be added.
* @param listener The listener object which will handle the
* notifications emitted by the registered MBean.
* @param filter The filter object. If filter is null, no
* filtering will be performed before handling notifications.
* @param handback The context to be sent to the listener when a
* notification is emitted.
*
* @exception InstanceNotFoundException The MBean name provided
* does not match any of the registered MBeans.
*/
public void addNotificationListener(ObjectName name,
NotificationListener listener,
NotificationFilter filter,
Object handback)
throws InstanceNotFoundException;
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.
Params: - 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.
- RuntimeOperationsException – Wraps an
IllegalArgumentException
. The MBean named by listener
exists but does not implement the NotificationListener
interface. - IOException – A communication problem occurred when
talking to the MBean server.
/**
* <p>Adds a listener to a registered MBean.</p>
*
* <p>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.</p>
*
* <p>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.</p>
*
* @param name The name of the MBean on which the listener should
* be added.
* @param listener The object name of the listener which will
* handle the notifications emitted by the registered MBean.
* @param filter The filter object. If filter is null, no
* filtering will be performed before handling notifications.
* @param handback The context to be sent to the listener when a
* notification is emitted.
*
* @exception InstanceNotFoundException The MBean name of the
* notification listener or of the notification broadcaster does
* not match any of the registered MBeans.
* @exception RuntimeOperationsException Wraps an {@link
* IllegalArgumentException}. The MBean named by
* <code>listener</code> exists but does not implement the {@link
* NotificationListener} interface.
* @exception IOException A communication problem occurred when
* talking to the MBean server.
*/
public void addNotificationListener(ObjectName name,
ObjectName listener,
NotificationFilter filter,
Object handback)
throws InstanceNotFoundException;
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.
Params: - 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.
/**
* Removes a listener from a registered MBean.
*
* <P> If the listener is registered more than once, perhaps with
* different filters or callbacks, this method will remove all
* those registrations.
*
* @param name The name of the MBean on which the listener should
* be removed.
* @param listener The object name of the listener to be removed.
*
* @exception InstanceNotFoundException The MBean name provided
* does not match any of the registered MBeans.
* @exception ListenerNotFoundException The listener is not
* registered in the MBean.
*/
public void removeNotificationListener(ObjectName name,
ObjectName listener)
throws InstanceNotFoundException, ListenerNotFoundException;
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.
Params: - 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.
/**
* <p>Removes a listener from a registered MBean.</p>
*
* <p>The MBean must have a listener that exactly matches the
* given <code>listener</code>, <code>filter</code>, and
* <code>handback</code> parameters. If there is more than one
* such listener, only one is removed.</p>
*
* <p>The <code>filter</code> and <code>handback</code> parameters
* may be null if and only if they are null in a listener to be
* removed.</p>
*
* @param name The name of the MBean on which the listener should
* be removed.
* @param listener A listener that was previously added to this
* MBean.
* @param filter The filter that was specified when the listener
* was added.
* @param handback The handback that was specified when the
* listener was added.
*
* @exception InstanceNotFoundException The MBean name provided
* does not match any of the registered MBeans.
* @exception ListenerNotFoundException The listener is not
* registered in the MBean, or it is not registered with the given
* filter and handback.
*/
public void removeNotificationListener(ObjectName name,
ObjectName listener,
NotificationFilter filter,
Object handback)
throws InstanceNotFoundException, ListenerNotFoundException;
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.
Params: - 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.
/**
* <p>Removes a listener from a registered MBean.</p>
*
* <P> If the listener is registered more than once, perhaps with
* different filters or callbacks, this method will remove all
* those registrations.
*
* @param name The name of the MBean on which the listener should
* be removed.
* @param listener The listener object which will handle the
* notifications emitted by the registered MBean.
*
* @exception InstanceNotFoundException The MBean name provided
* does not match any of the registered MBeans.
* @exception ListenerNotFoundException The listener is not
* registered in the MBean.
*/
public void removeNotificationListener(ObjectName name,
NotificationListener listener)
throws InstanceNotFoundException, ListenerNotFoundException;
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.
Params: - 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.
/**
* <p>Removes a listener from a registered MBean.</p>
*
* <p>The MBean must have a listener that exactly matches the
* given <code>listener</code>, <code>filter</code>, and
* <code>handback</code> parameters. If there is more than one
* such listener, only one is removed.</p>
*
* <p>The <code>filter</code> and <code>handback</code> parameters
* may be null if and only if they are null in a listener to be
* removed.</p>
*
* @param name The name of the MBean on which the listener should
* be removed.
* @param listener A listener that was previously added to this
* MBean.
* @param filter The filter that was specified when the listener
* was added.
* @param handback The handback that was specified when the
* listener was added.
*
* @exception InstanceNotFoundException The MBean name provided
* does not match any of the registered MBeans.
* @exception ListenerNotFoundException The listener is not
* registered in the MBean, or it is not registered with the given
* filter and handback.
*/
public void removeNotificationListener(ObjectName name,
NotificationListener listener,
NotificationFilter filter,
Object handback)
throws InstanceNotFoundException, ListenerNotFoundException;
This method discovers the attributes and operations that an
MBean exposes for management.
Params: - name – The name of the MBean to analyze
Throws: - IntrospectionException – An exception occurred during
introspection.
- InstanceNotFoundException – The MBean specified was
not found.
- ReflectionException – An exception occurred when
trying to invoke the getMBeanInfo of a Dynamic MBean.
Returns: An instance of MBeanInfo
allowing the
retrieval of all attributes and operations of this MBean.
/**
* This method discovers the attributes and operations that an
* MBean exposes for management.
*
* @param name The name of the MBean to analyze
*
* @return An instance of <CODE>MBeanInfo</CODE> allowing the
* retrieval of all attributes and operations of this MBean.
*
* @exception IntrospectionException An exception occurred during
* introspection.
* @exception InstanceNotFoundException The MBean specified was
* not found.
* @exception ReflectionException An exception occurred when
* trying to invoke the getMBeanInfo of a Dynamic MBean.
*/
public MBeanInfo getMBeanInfo(ObjectName name)
throws InstanceNotFoundException, IntrospectionException,
ReflectionException;
Returns true if the MBean specified is an instance of the
specified class, false otherwise.
Params: - name – The
ObjectName
of the MBean. - className – The name of the class.
Throws: - InstanceNotFoundException – The MBean specified is not
registered in the MBean server.
Returns: true if the MBean specified is an instance of the
specified class, false otherwise.
/**
* Returns true if the MBean specified is an instance of the
* specified class, false otherwise.
*
* @param name The <CODE>ObjectName</CODE> of the MBean.
* @param className The name of the class.
*
* @return true if the MBean specified is an instance of the
* specified class, false otherwise.
*
* @exception InstanceNotFoundException The MBean specified is not
* registered in the MBean server.
*/
public boolean isInstanceOf(ObjectName name, String className)
throws InstanceNotFoundException;
Return the ClassLoader
that was used for loading the class of the named MBean.
Params: - mbeanName – The ObjectName of the MBean.
Throws: - InstanceNotFoundException – if the named MBean is not found.
Returns: The ClassLoader used for that MBean.
/**
* <p>Return the {@link java.lang.ClassLoader} that was used for
* loading the class of the named MBean.
* @param mbeanName The ObjectName of the MBean.
* @return The ClassLoader used for that MBean.
* @exception InstanceNotFoundException if the named MBean is not found.
*/
public ClassLoader getClassLoaderFor(ObjectName mbeanName)
throws InstanceNotFoundException;
Return the named ClassLoader
.
Params: - loaderName – The ObjectName of the ClassLoader.
Throws: - InstanceNotFoundException – if the named ClassLoader is
not found.
Returns: The named ClassLoader.
/**
* <p>Return the named {@link java.lang.ClassLoader}.
* @param loaderName The ObjectName of the ClassLoader.
* @return The named ClassLoader.
* @exception InstanceNotFoundException if the named ClassLoader is
* not found.
*/
public ClassLoader getClassLoader(ObjectName loaderName)
throws InstanceNotFoundException;
}