|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jdmk.interceptor.DefaultMBeanServerInterceptor
public final class DefaultMBeanServerInterceptor
This is the default class for MBean manipulation on the agent side. It contains the methods necessary for the creation, registration, and deletion of MBeans as well as the access methods for registered MBeans. This is the core component of the JMX infrastructure.
Every MBean which is added to the MBean server becomes manageable: its attributes and operations become remotely accessible through the connectors/adaptors connected to that MBean server. A Java object cannot be registered in the MBean server unless it is a JMX compliant MBean.
When an MBean is registered or unregistered in the MBean server an
MBeanServerNotification
Notification is emitted. To register an object as listener to MBeanServerNotifications
you should call the MBean server method addNotificationListener
with ObjectName
the ObjectName
of the MBeanServerDelegate
.
This ObjectName
is:
JMImplementation:type=MBeanServerDelegate
.
Constructor Summary | |
---|---|
DefaultMBeanServerInterceptor(MBeanServer outer,
MBeanServerDelegate delegate,
MBeanServer inner)
Creates a DefaultMBeanServerInterceptor with the specified default domain name. |
Method Summary | |
---|---|
void |
addNotificationListener(ObjectName name,
NotificationListener listener,
NotificationFilter filter,
Object handback)
Adds a listener to a registered MBean. |
void |
addNotificationListener(ObjectName name,
ObjectName listener,
NotificationFilter filter,
Object handback)
Adds a listener to a registered MBean. |
ObjectInstance |
createMBean(String className,
ObjectName name,
Object[] params,
String[] signature)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(String className,
ObjectName name,
ObjectName loaderName,
Object[] params,
String[] signature)
Instantiates and registers an MBean in the MBean server. |
Object |
getAttribute(ObjectName name,
String attribute)
Gets the value of a specific attribute of a named MBean. |
AttributeList |
getAttributes(ObjectName name,
String[] attributes)
Enables the values of several attributes of a named MBean. |
ClassLoader |
getClassLoader(ObjectName loaderName)
Return the named ClassLoader . |
ClassLoader |
getClassLoaderFor(ObjectName mbeanName)
Return the ClassLoader that was used for
loading the class of the named MBean. |
String |
getDefaultDomain()
Returns the default domain used for naming the MBean. |
String[] |
getDomains()
Returns the list of domains in which any MBean is currently registered. |
ClassLoader |
getMBeanClassLoader(ObjectName name)
Deprecated. Use getClassLoaderFor(javax.management.ObjectName) |
Integer |
getMBeanCount()
Returns the number of MBeans registered in the MBean server. |
MBeanInfo |
getMBeanInfo(ObjectName name)
This method discovers the attributes and operations that an MBean exposes for management. |
ObjectInstance |
getObjectInstance(ObjectName name)
Gets the ObjectInstance for a given MBean
registered with the MBean server. |
Object |
invoke(ObjectName name,
String operationName,
Object[] params,
String[] signature)
Invokes an operation on an MBean. |
boolean |
isInstanceOf(ObjectName name,
String className)
Returns true if the MBean specified is an instance of the specified class, false otherwise. |
boolean |
isRegistered(ObjectName name)
Checks whether an MBean, identified by its object name, is already registered with the MBean server. |
Set |
queryMBeans(ObjectName name,
QueryExp query)
Gets MBeans controlled by the MBean server. |
Set |
queryNames(ObjectName name,
QueryExp query)
Gets the names of MBeans controlled by the MBean server. |
ObjectInstance |
registerMBean(Object object,
ObjectName name)
Registers a pre-existing object as an MBean with the MBean server. |
void |
removeNotificationListener(ObjectName name,
NotificationListener listener)
Removes a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName name,
NotificationListener listener,
NotificationFilter filter,
Object handback)
Removes a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName name,
ObjectName listener)
Removes a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName name,
ObjectName listener,
NotificationFilter filter,
Object handback)
Removes a listener from a registered MBean. |
void |
setAttribute(ObjectName name,
Attribute attribute)
Sets the value of a specific attribute of a named MBean. |
AttributeList |
setAttributes(ObjectName name,
AttributeList attributes)
Sets the values of several attributes of a named MBean. |
void |
unregisterMBean(ObjectName name)
Unregisters an MBean from the MBean server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultMBeanServerInterceptor(MBeanServer outer, MBeanServerDelegate delegate, MBeanServer inner)
Do not forget to call initialize(outer,delegate)
before using this object.
outer
- A pointer to the MBeanServer object that must be
passed to the MBeans when invoking their
MBeanRegistration
interface.delegate
- A pointer to the MBeanServerDelegate associated
with the new MBeanServer. The new MBeanServer must register
this MBean in its MBean repository.inner
- A pointer to the inner MBeanServer object to which
this DefaultMBeanServerInterceptor is forwarding the calls.Method Detail |
---|
public ObjectInstance createMBean(String className, ObjectName name, Object[] params, String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
MBeanInterceptor
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.
createMBean
in interface MBeanInterceptor
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.
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated 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.
MBeanException
- The constructor of the MBean has
thrown an exception
NotCompliantMBeanException
public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException
MBeanInterceptor
MBeanRegistration
interface and returning the name from the preRegister
method.
createMBean
in interface MBeanInterceptor
className
- The class name of the MBean to be instantiated.name
- The object name of the MBean. May be null.loaderName
- The object name of the class loader to be used.params
- An array containing the parameters of the
constructor to be invoked.signature
- An array containing the signature of the
constructor to be invoked.
ObjectInstance
, containing the
ObjectName
and the Java class name of the newly
instantiated 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.
MBeanException
- The constructor of the MBean has
thrown an exception
InstanceNotFoundException
- The specified class loader
is not registered in the MBean server.
NotCompliantMBeanException
public ObjectInstance registerMBean(Object object, ObjectName name) throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException
MBeanInterceptor
MBeanRegistration
interface
and returning the name from the preRegister
method.
registerMBean
in interface MBeanInterceptor
object
- The MBean to be registered as an MBean.name
- The object name of the MBean. May be null.
ObjectInstance
for the MBean that has
been registered.
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 MBeanpublic void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException
MBeanInterceptor
unregisterMBean
in interface MBeanInterceptor
unregisterMBean
in interface ProxyHandler
name
- The object name of the MBean to be unregistered.
InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.
MBeanRegistrationException
- The preDeregister
((MBeanRegistration
interface) method of the MBean
has thrown an exception.public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException
MBeanInterceptor
ObjectInstance
for a given MBean
registered with the MBean server.
getObjectInstance
in interface MBeanInterceptor
name
- The object name of the MBean.
ObjectInstance
associated to the MBean
specified by name.
InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.public Set queryMBeans(ObjectName name, QueryExp query)
MBeanInterceptor
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.
queryMBeans
in interface MBeanInterceptor
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.
ObjectInstance
objects for the selected MBeans. If no MBean satisfies the
query an empty list is returned.public Set queryNames(ObjectName name, QueryExp query)
MBeanInterceptor
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.
queryNames
in interface MBeanInterceptor
name
- The object name pattern identifying the MBean names
to be retrieved. If null or no domain and key properties are
specified, the name of all registered MBeans will be retrieved.query
- The query expression to be applied for selecting
MBeans. If null no query expression will be applied for
selecting MBeans.
public boolean isRegistered(ObjectName name)
MBeanInterceptor
isRegistered
in interface MBeanInterceptor
name
- The object name of the MBean to be checked.
public Integer getMBeanCount()
MBeanInterceptor
getMBeanCount
in interface MBeanInterceptor
public Object getAttribute(ObjectName name, String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException
MBeanInterceptor
getAttribute
in interface MBeanInterceptor
getAttribute
in interface ProxyHandler
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.
MBeanException
- Wraps an exception thrown by the
MBean's getter.
AttributeNotFoundException
- The attribute specified
is not accessible in the MBean.
InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.
ReflectionException
- Wraps a
java.lang.Exception
thrown when trying to invoke
the setter.public AttributeList getAttributes(ObjectName name, String[] attributes) throws InstanceNotFoundException, ReflectionException
MBeanInterceptor
getAttributes
in interface MBeanInterceptor
getAttributes
in interface ProxyHandler
name
- The object name of the MBean from which the
attributes are retrieved.attributes
- A list of the attributes to be retrieved.
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.public void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException
MBeanInterceptor
setAttribute
in interface MBeanInterceptor
setAttribute
in interface ProxyHandler
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.
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.public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException, ReflectionException
MBeanInterceptor
setAttributes
in interface MBeanInterceptor
setAttributes
in interface ProxyHandler
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.
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.public Object invoke(ObjectName name, String operationName, Object[] params, String[] signature) throws InstanceNotFoundException, MBeanException, ReflectionException
MBeanInterceptor
invoke
in interface MBeanInterceptor
invoke
in interface ProxyHandler
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 invokedsignature
- 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.
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.public String getDefaultDomain()
MBeanInterceptor
getDefaultDomain
in interface MBeanInterceptor
public String[] getDomains()
MBeanServerInterceptor
getDomains
in interface MBeanServerInterceptor
public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException
MBeanInterceptor
Adds a listener to a registered MBean.
A notification emitted by an MBean will be forwarded by the MBeanServer to the listener. If the source of the notification is a reference to an MBean object, the MBean server will replace it by that MBean's ObjectName. Otherwise the source is unchanged.
addNotificationListener
in interface MBeanInterceptor
addNotificationListener
in interface NotificationRegistration
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.
InstanceNotFoundException
- The MBean name provided
does not match any of the registered MBeans.public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException
MBeanInterceptor
Adds a listener to a registered MBean.
A notification emitted by an MBean will be forwarded by the MBeanServer to the listener. If the source of the notification is a reference to an MBean object, the MBean server will replace it by that MBean's ObjectName. Otherwise the source is unchanged.
The listener object that receives notifications is the one that is registered with the given name at the time this method is called. Even if it is subsequently unregistered, it will continue to receive notifications.
addNotificationListener
in interface MBeanInterceptor
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.
InstanceNotFoundException
- The MBean name of the
notification listener or of the notification broadcaster does
not match any of the registered MBeans.public void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException
MBeanInterceptor
If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.
removeNotificationListener
in interface MBeanInterceptor
name
- The name of the MBean on which the listener should
be removed.listener
- The object name of the listener to be removed.
InstanceNotFoundException
- The MBean name provided
does not match any of the registered MBeans.
ListenerNotFoundException
- The listener is not
registered in the MBean.public void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServerInterceptor
Removes a listener from a registered MBean.
The MBean must have a listener that exactly matches the
given listener
, filter
, and
handback
parameters. If there is more than one
such listener, only one is removed.
The filter
and handback
parameters
may be null if and only if they are null in a listener to be
removed.
removeNotificationListener
in interface MBeanServerInterceptor
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.
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.public void removeNotificationListener(ObjectName name, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException
MBeanInterceptor
Removes a listener from a registered MBean.
If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.
removeNotificationListener
in interface MBeanInterceptor
removeNotificationListener
in interface NotificationRegistration
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.
InstanceNotFoundException
- The MBean name provided
does not match any of the registered MBeans.
ListenerNotFoundException
- The listener is not
registered in the MBean.public void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServerInterceptor
Removes a listener from a registered MBean.
The MBean must have a listener that exactly matches the
given listener
, filter
, and
handback
parameters. If there is more than one
such listener, only one is removed.
The filter
and handback
parameters
may be null if and only if they are null in a listener to be
removed.
removeNotificationListener
in interface MBeanServerInterceptor
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.
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.public MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException, ReflectionException
MBeanInterceptor
getMBeanInfo
in interface MBeanInterceptor
getMBeanInfo
in interface ProxyHandler
name
- The name of the MBean to analyze
MBeanInfo
allowing the
retrieval of all attributes and operations of this MBean.
InstanceNotFoundException
- The MBean specified was
not found.
IntrospectionException
- An exception occurred during
introspection.
ReflectionException
- An exception occurred when
trying to invoke the getMBeanInfo of a Dynamic MBean.public boolean isInstanceOf(ObjectName name, String className) throws InstanceNotFoundException
MBeanInterceptor
isInstanceOf
in interface MBeanInterceptor
name
- The ObjectName
of the MBean.className
- The name of the class.
InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.public final ClassLoader getMBeanClassLoader(ObjectName name) throws InstanceNotFoundException
getClassLoaderFor(javax.management.ObjectName)
MBeanServerInterceptor
Return the ClassLoader
that was used for
loading the class of the named MBean.
getMBeanClassLoader
in interface MBeanServerInterceptor
getMBeanClassLoader
in interface MBeanInterceptor
name
- The ObjectName of the MBean.
InstanceNotFoundException
- if the named MBean is not found.public ClassLoader getClassLoader(ObjectName loaderName) throws InstanceNotFoundException
MBeanServerInterceptor
Return the named ClassLoader
.
getClassLoader
in interface MBeanServerInterceptor
loaderName
- The ObjectName of the ClassLoader.
InstanceNotFoundException
- if the named ClassLoader is
not found.public ClassLoader getClassLoaderFor(ObjectName mbeanName) throws InstanceNotFoundException
MBeanServerInterceptor
Return the ClassLoader
that was used for
loading the class of the named MBean.
getClassLoaderFor
in interface MBeanServerInterceptor
mbeanName
- The ObjectName of the MBean.
InstanceNotFoundException
- if the named MBean is not found.
|
Open Source build 02 opendmk-1.0-b02 2007.10.01_19:17:46_MEST |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |