|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteMBeanServer
Since the original JMX spec, JMX now supports a remote API for the MBeanServer, thus this legacy interface now extends that remote API.
MBeanServerConnection
Method Summary | |
---|---|
void |
addNotificationListener(ObjectName objectName,
NotificationListener listener,
NotificationFilter filter,
java.lang.Object handback)
Adds a listener to a registered MBean. |
void |
addNotificationListener(ObjectName objectName,
ObjectName listener,
NotificationFilter filter,
java.lang.Object handback)
Adds a listener to a registered MBean. |
java.lang.String |
connect(JMSConnectorAddress address)
|
ObjectInstance |
createMBean(java.lang.String className,
ObjectName objectName)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName objectName,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName objectName,
ObjectName loaderName)
Instantiates and registers an MBean in the MBean server. |
ObjectInstance |
createMBean(java.lang.String className,
ObjectName objectName,
ObjectName loaderName,
java.lang.Object[] params,
java.lang.String[] signature)
Instantiates and registers an MBean in the MBean server. |
void |
disconnect()
|
java.lang.Object |
getAttribute(ObjectName objectName,
java.lang.String attribute)
Gets the value of a specific attribute of a named MBean. |
AttributeList |
getAttributes(ObjectName objectName,
java.lang.String[] attributes)
Enables the values of several attributes of a named MBean. |
java.lang.String |
getDefaultDomain()
Returns the default domain used for naming the MBean. |
java.lang.Integer |
getMBeanCount()
Returns the number of MBeans registered in the MBean server. |
MBeanInfo |
getMBeanInfo(ObjectName objectName)
This method discovers the attributes and operations that an MBean exposes for management. |
ObjectInstance |
getObjectInstance(ObjectName objectName)
Gets the ObjectInstance for a given MBean
registered with the MBean server. |
java.lang.Object |
invoke(ObjectName objectName,
java.lang.String operationName,
java.lang.Object[] params,
java.lang.String[] signature)
Invokes an operation on an MBean. |
boolean |
isConnected()
|
boolean |
isInstanceOf(ObjectName objectName,
java.lang.String className)
Returns true if the MBean specified is an instance of the specified class, false otherwise. |
boolean |
isRegistered(ObjectName objectName)
Checks whether an MBean, identified by its object name, is already registered with the MBean server. |
java.util.Set |
queryMBeans(ObjectName objectName,
QueryExp query)
Gets MBeans controlled by the MBean server. |
java.util.Set |
queryNames(ObjectName objectName,
QueryExp query)
Gets the names of MBeans controlled by the MBean server. |
void |
removeNotificationListener(ObjectName objectName,
NotificationListener listener)
Removes a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName objectName,
NotificationListener listener,
NotificationFilter filter,
java.lang.Object handback)
Removes a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName objectName,
ObjectName listener)
Removes a listener from a registered MBean. |
void |
removeNotificationListener(ObjectName objectName,
ObjectName listener,
NotificationFilter filter,
java.lang.Object handback)
Removes a listener from a registered MBean. |
void |
setAttribute(ObjectName objectName,
Attribute attribute)
Sets the value of a specific attribute of a named MBean. |
AttributeList |
setAttributes(ObjectName objectName,
AttributeList attributes)
Sets the values of several attributes of a named MBean. |
void |
unregisterMBean(ObjectName objectName)
Unregisters an MBean from the MBean server. |
Methods inherited from interface javax.management.MBeanServerConnection |
---|
getDomains |
Method Detail |
---|
void addNotificationListener(ObjectName objectName, NotificationListener listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.MBeanServerConnection.removeNotificationListener(ObjectName, NotificationListener)
,
MBeanServerConnection.removeNotificationListener(ObjectName, NotificationListener,
NotificationFilter, Object)
void addNotificationListener(ObjectName objectName, ObjectName listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName)
,
MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName,
NotificationFilter, Object)
java.lang.String connect(JMSConnectorAddress address)
ObjectInstance createMBean(java.lang.String className, ObjectName objectName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
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.
This method is equivalent to createMBean(className, name, (Object[]) null, (String[])
null)
.
createMBean
in interface MBeanServerConnection
className
- The class name of the MBean to be instantiated.objectName
- The object name of the MBean. May be null.
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()
.
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
- This class is not a JMX
compliant MBeanObjectInstance createMBean(java.lang.String className, ObjectName objectName, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException
MBeanServerConnection
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 MBeanServerConnection
className
- The class name of the MBean to be instantiated.objectName
- 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. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.
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
- This class is not a JMX
compliant MBeanObjectInstance createMBean(java.lang.String className, ObjectName objectName, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException
MBeanServerConnection
Instantiates and registers an MBean in the MBean server. The
class loader to be used is identified by its object name. An
object name is associated to the MBean. If the object name of
the loader is null, the ClassLoader that loaded the MBean
server will be used. If the MBean's object name given is null,
the MBean must provide its own name by implementing the MBeanRegistration
interface
and returning the name from the preRegister
method.
This method is equivalent to createMBean(className, name, loaderName, (Object[]) null,
(String[]) null)
.
createMBean
in interface MBeanServerConnection
className
- The class name of the MBean to be instantiated.objectName
- The object name of the MBean. May be null.loaderName
- The object name of the class loader to be used.
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()
.
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
- This class is not a JMX
compliant MBean
InstanceNotFoundException
- The specified class loader
is not registered in the MBean server.ObjectInstance createMBean(java.lang.String className, ObjectName objectName, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException
MBeanServerConnection
MBeanRegistration
interface and returning the name from the preRegister
method.
createMBean
in interface MBeanServerConnection
className
- The class name of the MBean to be instantiated.objectName
- 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. If the contained ObjectName
is n
, the contained Java class name is
getMBeanInfo(n)
.getClassName()
.
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
- This class is not a JMX
compliant MBean
InstanceNotFoundException
- The specified class loader
is not registered in the MBean server.void disconnect()
java.lang.Object getAttribute(ObjectName objectName, java.lang.String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException
MBeanServerConnection
getAttribute
in interface MBeanServerConnection
objectName
- 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.MBeanServerConnection.setAttribute(javax.management.ObjectName, javax.management.Attribute)
AttributeList getAttributes(ObjectName objectName, java.lang.String[] attributes) throws InstanceNotFoundException, ReflectionException
MBeanServerConnection
getAttributes
in interface MBeanServerConnection
objectName
- 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.MBeanServerConnection.setAttributes(javax.management.ObjectName, javax.management.AttributeList)
java.lang.String getDefaultDomain()
MBeanServerConnection
getDefaultDomain
in interface MBeanServerConnection
java.lang.Integer getMBeanCount()
MBeanServerConnection
getMBeanCount
in interface MBeanServerConnection
MBeanInfo getMBeanInfo(ObjectName objectName) throws InstanceNotFoundException, IntrospectionException, ReflectionException
MBeanServerConnection
getMBeanInfo
in interface MBeanServerConnection
objectName
- 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 occured during
introspection.
ReflectionException
- An exception occurred when
trying to invoke the getMBeanInfo of a Dynamic MBean.ObjectInstance getObjectInstance(ObjectName objectName) throws InstanceNotFoundException
MBeanServerConnection
ObjectInstance
for a given MBean
registered with the MBean server.
getObjectInstance
in interface MBeanServerConnection
objectName
- The object name of the MBean.
ObjectInstance
associated with the MBean
specified by name. The contained ObjectName
is name
and the contained class name is
getMBeanInfo(name)
.getClassName()
.
InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.java.lang.Object invoke(ObjectName objectName, java.lang.String operationName, java.lang.Object[] params, java.lang.String[] signature) throws InstanceNotFoundException, MBeanException, ReflectionException
MBeanServerConnection
invoke
in interface MBeanServerConnection
objectName
- 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.boolean isConnected()
boolean isInstanceOf(ObjectName objectName, java.lang.String className) throws InstanceNotFoundException
MBeanServerConnection
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.
isInstanceOf
in interface MBeanServerConnection
objectName
- The ObjectName
of the MBean.className
- The name of the class.
InstanceNotFoundException
- The MBean specified is not
registered in the MBean server.boolean isRegistered(ObjectName objectName)
MBeanServerConnection
isRegistered
in interface MBeanServerConnection
objectName
- The object name of the MBean to be checked.
java.util.Set queryMBeans(ObjectName objectName, QueryExp query)
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.java.util.Set queryNames(ObjectName objectName, QueryExp query)
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.
void removeNotificationListener(ObjectName objectName, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.MBeanServerConnection.addNotificationListener(ObjectName, NotificationListener,
NotificationFilter, Object)
void removeNotificationListener(ObjectName objectName, NotificationListener listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.MBeanServerConnection.addNotificationListener(ObjectName, NotificationListener,
NotificationFilter, Object)
void removeNotificationListener(ObjectName objectName, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServerConnection
If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.
removeNotificationListener
in interface MBeanServerConnection
objectName
- 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.MBeanServerConnection.addNotificationListener(ObjectName, ObjectName,
NotificationFilter, Object)
void removeNotificationListener(ObjectName objectName, ObjectName listener, NotificationFilter filter, java.lang.Object handback) throws InstanceNotFoundException, ListenerNotFoundException
MBeanServerConnection
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 MBeanServerConnection
objectName
- 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.MBeanServerConnection.addNotificationListener(ObjectName, ObjectName,
NotificationFilter, Object)
void setAttribute(ObjectName objectName, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException
MBeanServerConnection
setAttribute
in interface MBeanServerConnection
objectName
- 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.MBeanServerConnection.getAttribute(javax.management.ObjectName, java.lang.String)
AttributeList setAttributes(ObjectName objectName, AttributeList attributes) throws InstanceNotFoundException, ReflectionException
MBeanServerConnection
setAttributes
in interface MBeanServerConnection
objectName
- 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.MBeanServerConnection.getAttributes(javax.management.ObjectName, java.lang.String[])
void unregisterMBean(ObjectName objectName) throws InstanceNotFoundException, MBeanRegistrationException
MBeanServerConnection
unregisterMBean
in interface MBeanServerConnection
objectName
- 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.
|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |