com.adventnet.adaptors.clients.rmi
Class RMIClient

java.lang.Object
  |
  +--com.adventnet.adaptors.clients.AbstractClient
        |
        +--com.adventnet.adaptors.clients.rmi.RMIClient

public class RMIClient

extends AbstractClient

Inner classes inherited from class com.adventnet.adaptors.clients.AbstractClient

AbstractClient.HeartBeatDiagnoser

Field Summary

(package private) boolean	connectMode
java.lang.String	mbeanServerID

Fields inherited from class com.adventnet.adaptors.clients.AbstractClient

adaptorInfo, clientProp, heartBeatDiagnoser, heartBeatEnabled, heartBeatRate, host, isSubAgentAlive, listeners, port

Constructor Summary

RMIClient()

Method Summary

void	addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, java.lang.Object handback) Enables a couple (listener,handback) for a registered MBean to be added using this client through the relevant adaptor.
void	addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, java.lang.Object handback) Enables a couple (listener,handback) for a registered MBean to be added using this client through the relevant adaptor.
void	authenticate(com.adventnet.agent.security.UserContext userContext) Authenticates the user corresponig to the UserContext passed
void	connect(java.lang.String host, int port, java.lang.Object adaptorInfo) Initializes the communication with the remote managed object server.
ObjectInstance	createMBean(java.lang.String className, ObjectName name) Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor.
ObjectInstance	createMBean(java.lang.String className, ObjectName name, java.lang.Object[] params, java.lang.String[] signature) Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor.The MBean server will use the DefaultLoaderRepository to load the class of the MBean.
ObjectInstance	createMBean(java.lang.String className, ObjectName name, ObjectName loaderName) Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor.
ObjectInstance	createMBean(java.lang.String className, ObjectName name, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor.The class loader to be used is identified by its object name.
java.io.ObjectInputStream	deserialize(ObjectName objectName, byte[] data) Deserializes the data passed
java.io.ObjectInputStream	deserialize(java.lang.String className, byte[] data) De-serializes a byte array in the context of a given MBean class loader.
java.io.ObjectInputStream	deserialize(java.lang.String className, ObjectName objectName, byte[] data) De-serializes a byte array in the context of a given MBean class loader.
void	disconnect() Diconnects the communication with the adaptor.
java.lang.Object	getAttribute(ObjectName name, java.lang.String attribute) Gets the value of a specific attribute of a named MBean using this client through the relevant adaptor.
AttributeList	getAttributes(ObjectName name, java.lang.String[] attributes) Enables the values of several attributes of a named MBean using this client through the relevant adaptor.
java.lang.ClassLoader	getClassLoader(ObjectName loaderName) Return the named ClassLoader.
java.lang.ClassLoader	getClassLoaderFor(ObjectName mbeanName) Return the ClassLoader that was used for loading the class of the named MBean.
ClassLoaderRepository	getClassLoaderRepository() Return the ClassLoaderRepository for this MBeanServer.
java.lang.String	getDefaultDomain() Returns the default domain used for naming the MBean.
java.lang.String[]	getDomains() Returns the list of domains in which any MBean is currently registered.
java.lang.Integer	getMBeanCount() Returns the number of MBeans controlled by the MBeanServer using this client through the relevant adaptor.
MBeanInfo	getMBeanInfo(ObjectName name) This method discovers the attributes and operations that an MBean exposes for management using this client through the relevant adaptor.When flatten is false, inherited attributes are not returned.
java.lang.String	getMBeanServerID() Returns the MBeanServerID
ObjectInstance	getObjectInstance(ObjectName name) Gets the ObjectInstance for a given MBean registered with the MBean server using this client through the relevant adaptor.
java.lang.Object	instantiate(java.lang.String className) Instantiates an object using the list of all class loaders registered in the MBean server (Default Loader Repository using this client through the relevant adaptor.
java.lang.Object	instantiate(java.lang.String className, java.lang.Object[] params, java.lang.String[] signature) Instantiates an object using the list of all class loaders registered in the MBean server (Default Loader Repository) using this client through the relevant adaptor.The object's class should have a public constructor.
java.lang.Object	instantiate(java.lang.String className, ObjectName loaderName) Instantiates an object using the class Loader specified by its ObjectName using this client through the relevant adaptor.
java.lang.Object	instantiate(java.lang.String className, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) Instantiates an object using this client through the relevant adaptor.
java.lang.Object	invoke(ObjectName name, java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) Invokes an action on an MBean using this client through the relevant adaptor.
boolean	isAuthenticationEnabled() Determines whether authentication is enabled or not
java.lang.Boolean	isConnectedWithAdaptor() Indicates whether the RMI client is connected with the RMI adaptor.
boolean	isInstanceOf(ObjectName name, java.lang.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 MBeanServer using this client through the relevant adaptor.
java.util.Set	queryMBeans(ObjectName name, QueryExp query) Gets MBeans controlled by the MBeanServer using this client through the relevant adaptor.
java.util.Set	queryNames(ObjectName name, QueryExp query) Gets the names of MBeans controlled by the MBeanServer using this client through the relevant adaptor.
ObjectInstance	registerAsModelMBean(java.lang.Object mbean, java.lang.String xmlFile, ObjectName name) Remote method call which registers the MBean.
ObjectInstance	registerMBean(java.lang.Object object, ObjectName objectName) Registers a pre-existing object as an MBean with the MBean server.
ObjectInstance	registerMBean(java.lang.String className, ObjectName name) Registers a pre-existing object as an MBean with the MBeanServer using this client through the relevant adaptor.
void	removeNotificationListener(ObjectName name, NotificationListener listener) Enables a listener for an MBean to be removed using this client through the relevant adaptor.
void	removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, java.lang.Object handback) Removes a listener from a registered MBean.
void	removeNotificationListener(ObjectName name, ObjectName listener) Enables a listener for an MBean to be removed using this client through the relevant adaptor.
void	removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, java.lang.Object handback) Removes a listener from a registered MBean.
void	sendHeartBeatEvent() This synchronized method sends the HeartBeartEvent to all the registered listeners
void	setAttribute(ObjectName name, Attribute attribute) Sets the value of a specific attribute of a named MBean using this client through the relevant adaptor.
AttributeList	setAttributes(ObjectName name, AttributeList attributes) Sets the values of several attributes of a named MBean using this client through the relevant adaptor.
void	unregisterMBean(ObjectName name) De-registers an MBean from the MBeanServer using this client through the relevant adaptor.

Methods inherited from class com.adventnet.adaptors.clients.AbstractClient

addHeartBeatListener, asyncGetAttribute, asyncGetAttributes, asyncInvoke, asyncSetAttributes, enableHeartBeat, getHeartBeatRate, isHeartBeatEnabled, removeHeartBeatListener, setHeartBeatRate, setProperty, startHeartBeat, stopHeartBeat

Methods inherited from class java.lang.Object

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

Field Detail

connectMode

boolean connectMode

mbeanServerID

public java.lang.String mbeanServerID

Constructor Detail

RMIClient

public RMIClient()

Method Detail

deserialize

public java.io.ObjectInputStream deserialize(ObjectName objectName,
                                             byte[] data)
                                      throws InstanceNotFoundException,
                                             OperationsException

Deserializes the data passed

Parameters:

objectName - The objectName of the MBean

data - The data as byte array

Throws:

InstanceNotFoundException - If the specified MBean is not registered with the MBeanServer

OperationsException -

deserialize

public java.io.ObjectInputStream deserialize(java.lang.String className,
                                             byte[] data)
                                      throws OperationsException,
                                             ReflectionException

Description copied from interface: MBeanServer

De-serializes a byte array in the context of a given MBean class loader. The class loader is found by loading the class className through the Class Loader Repository. The resultant class's class loader is the one to use.

Parameters:

className - The class name

data - The data as byte array

Throws:

ReflectionException -

OperationsException -

deserialize

public java.io.ObjectInputStream deserialize(java.lang.String className,
                                             ObjectName objectName,
                                             byte[] data)
                                      throws InstanceNotFoundException,
                                             OperationsException,
                                             ReflectionException

Description copied from interface: MBeanServer

De-serializes a byte array in the context of a given MBean class loader. The class loader is the one that loaded the class with name "className". The name of the class loader to be used for loading the specified class is specified. If null, the MBean Server's class loader will be used.

Parameters:

className - The class name

objectName - The object name of the mbean

data - The data as byte array

Throws:

InstanceNotFoundException - If the specifed MBean is not registered with the MBeanServer

OperationsException -

ReflectionException -

connect

public void connect(java.lang.String host,
                    int port,
                    java.lang.Object adaptorInfo)
             throws java.net.ConnectException

Initializes the communication with the remote managed object server.

Overrides:

connect in class AbstractClient

Parameters:

host - The host name of the adaptor.

port - The port number of the adaptor.

adaptorInfo - The information object specific to the adaptor. Here the Factory object look up name String can be specfied. If null, then lookup is made for "AdventnetRMIAdaptor"

Throws:

-

authenticate

public void authenticate(com.adventnet.agent.security.UserContext userContext)
                  throws com.adventnet.agent.security.AuthenticationException

Authenticates the user corresponig to the UserContext passed

Overrides:

authenticate in class AbstractClient

Parameters:

userContext - The UserContext corresponding to the user

isAuthenticationEnabled

public boolean isAuthenticationEnabled()

Determines whether authentication is enabled or not

Overrides:

isAuthenticationEnabled in class AbstractClient

Returns:

boolean true if Authentication is enabled and false otherwise

disconnect

public void disconnect()

Diconnects the communication with the adaptor.

Overrides:

disconnect in class AbstractClient

isConnectedWithAdaptor

public java.lang.Boolean isConnectedWithAdaptor()

Indicates whether the RMI client is connected with the RMI adaptor.

Overrides:

isConnectedWithAdaptor in class AbstractClient

Returns:

True, If Corba Client is connected with the Adaptor else False.

sendHeartBeatEvent

public void sendHeartBeatEvent()

This synchronized method sends the HeartBeartEvent to all the registered listeners

Overrides:

sendHeartBeatEvent in class AbstractClient

getMBeanServerID

public java.lang.String getMBeanServerID()

Returns the MBeanServerID

addNotificationListener

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

Enables a couple (listener,handback) for a registered MBean to be added using this client through the relevant adaptor.

Parameters:

name - The name of the MBean on which the listener should be added.

listener - The listener object which will handles notifications emitted by the registered MBean.

filter - The filter object. If not specified, 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 doesn't correspond to a registered MBean.

addNotificationListener

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

Enables a couple (listener,handback) for a registered MBean to be added using this client through the relevant adaptor.

Parameters:

name - The name of the MBean on which the listener should be added.

listener - The listener name which will handles notifications emitted by the registered MBean.

filter - The filter object. If not specified, 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 doesn't correspond to a registered MBean.

createMBean

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

Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor. The MBean server will use the DefaultLoaderRepository to load the class of the MBean. An object name is associated to the MBean. If the object name given is null, the MBean can automatically provide its own name by implementing the MBeanRegistration interface. The call returns a reference to the new instance and its object name.

Parameters:

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

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

Returns:

An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean.

Throws:

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

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

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 an JMX compliant MBean

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.

createMBean

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

Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor.The MBean server will use the DefaultLoaderRepository to load the class of the MBean. An object name is associated to the MBean. If the object name given is null, the MBean can automatically provide its own name by implementing the MBeanRegistration interface. The call returns a reference to the new instance and its object name.

Parameters:

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

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

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

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

Returns:

An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean.

Throws:

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

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

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 an JMX compliant MBean

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.

createMBean

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

Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor. 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 system ClassLoader will be used.If the MBean's object name given is null, the MBean can automatically provide its own name by implementing the MBeanRegistration interface. The call returns a reference to the new instance and its object name.

Parameters:

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

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

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

Returns:

An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean.

Throws:

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

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 an JMX compliant MBean

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

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.

createMBean

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

Instantiates and registers a MBean with the MBeanServer using this client through the relevant adaptor.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 system ClassLoader will be used.If the MBean object name given is null, the MBean can automatically provide its own name by implementing the MBeanRegistration interface. The call returns a reference to the new instance and its object name.

Parameters:

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

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

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

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

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

Returns:

An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean.

Throws:

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

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

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 an JMX compliant MBean

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

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.

getAttribute

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

Gets the value of a specific attribute of a named MBean using this client through the relevant adaptor. The MBean is identified by its object name.

Parameters:

name - The object name of the MBean from which the attribute is to be retrieved.

attribute - A String specifying the name of the attribute to be retrieved.

Returns:

The value of the retrieved attribute.

Throws:

ReflectionException - wraps a ClassNotFoundException or a java.lang.Exception that occured trying to invoke the MBean's constructor.

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

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

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

ReflectionException - Wraps an java.lang.Exception thrown while 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.

getAttributes

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

Enables the values of several attributes of a named MBean using this client through the relevant adaptor. The MBean is identified by its object name.

Parameters:

name - The object name of the MBean from which the attributes are to be retrieved.

attributes - A list of the attributes to be retrieved.

Returns:

The list of the retrieved attributes.

Throws:

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

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 the attribute in parameter is null.

getDefaultDomain

public java.lang.String getDefaultDomain()

Returns the default domain used for naming the MBean. using this client through the relevant adaptor. 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.

getDomains

public java.lang.String[] getDomains()

Returns the list of domains in which any MBean is currently registered. A string is in the returned array if and only if there is at least one MBean registered with an ObjectName whose getDomain() is equal to that string. The order of strings within the returned array is not defined.

Returns:

string array containing the list of domains

getMBeanCount

public java.lang.Integer getMBeanCount()

Returns the number of MBeans controlled by the MBeanServer using this client through the relevant adaptor.

Returns:

The number of MBeans controlled by the MBeanServer

getMBeanInfo

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

This method discovers the attributes and operations that an MBean exposes for management using this client through the relevant adaptor.When flatten is false, inherited attributes are not returned.

Parameters:

name - The name of the MBean to analyze

Returns:

An instance of MBeanInfo allowing to retrieve all attributes and operations of this MBean.

Throws:

java.beans.IntrospectionException - An exception occurs during introspection.

InstanceNotFoundException - The specified MBean is not found.

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

getObjectInstance

public ObjectInstance getObjectInstance(ObjectName name)
                                 throws InstanceNotFoundException

Gets the ObjectInstance for a given MBean registered with the MBean server using this client through the relevant adaptor.

Parameters:

name - The object name of the MBean.

Returns:

The ObjectInstance associated to the MBean specified by name.

Throws:

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

instantiate

public java.lang.Object instantiate(java.lang.String className)
                             throws ReflectionException,
                                    MBeanException

Instantiates an object using the list of all class loaders registered in the MBean server (Default Loader Repository using this client through the relevant adaptor. The object's class should have a public constructor. It returns a reference to the newly created object. The newly created object is not registered in the MBean server.

Parameters:

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

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

instantiate

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

Instantiates an object using the list of all class loaders registered in the MBean server (Default Loader Repository) using this client through the relevant adaptor.The object's class should have a public constructor. The call returns a reference to the newly created object. The newly created object is not registered in the MBean server.

Parameters:

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

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

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

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

instantiate

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

Instantiates an object using the class Loader specified by its ObjectName using this client through the relevant adaptor. If the loader name is null, the ClassLoader that loaded the MBean Server will be used. The object's class should have a public constructor. It returns a reference to the newly created object. The newly created object is not registered in the MBean server.

Parameters:

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

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

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception

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

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

instantiate

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

Instantiates an object using this client through the relevant adaptor. The class loader to be used is identified by its object name. If the object name of the loader is null, the ClassLoader that loaded the MBean server will be used. The object's class should have a public constructor. The call returns a reference to the newly created object. The newly created object is not registered in the MBean server.

Parameters:

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

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

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

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

Returns:

The newly instantiated object.

Throws:

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

MBeanException - The constructor of the object has thrown an exception

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

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

invoke

public java.lang.Object invoke(ObjectName name,
                               java.lang.String actionName,
                               java.lang.Object[] params,
                               java.lang.String[] signature)
                        throws InstanceNotFoundException,
                               MBeanException,
                               ReflectionException

Invokes an action on an MBean using this client through the relevant adaptor.

Parameters:

name - The object name of the MBean on which the method is to be invoked.

actionName - The name of the action to be invoked.

params - An array containing the parameters to be set when the action is invoked

signature - An array containing the signature of the action. The class objects will be loaded using the same class loader as the one used for loading the MBean on which the action was invoked.

Returns:

The object returned by the action, which represents the result ofinvoking the action on the specified MBean.

Throws:

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

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

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

isRegistered

public boolean isRegistered(ObjectName name)

Checks whether an MBean, identified by its object name, is already registered with the MBeanServer using this client through the relevant adaptor.

Parameters:

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

Returns:

true if the MBean is already controlled by the MBeanServer, false otherwise.

Throws:

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The ObjectName parameter is null.

isInstanceOf

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

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

Parameters:

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

className - The name of the class.

Returns:

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

Throws:

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

queryMBeans

public java.util.Set queryMBeans(ObjectName name,
                                 QueryExp query)

Gets MBeans controlled by the MBeanServer using this client through the relevant adaptor. 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 empty, 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.

Parameters:

name - The object name pattern identifying the MBeans to be retrieved. If null orempty all the MBeans registered will be retrieved.

query - The query expression to be applied for selecting MBeans.

Returns:

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

queryNames

public java.util.Set queryNames(ObjectName name,
                                QueryExp query)

Gets the names of MBeans controlled by the MBeanServer using this client through the relevant adaptor. 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 empty, all objects are to be selected (and filtered if a query is specified). It returns the set of ObjectNames for the MBeans selected.

Parameters:

name - The object name pattern identifying the MBean names to be retrieved. If null or empty, the name of all registered MBeans will be retrieved.

query - The query expression to 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.

registerMBean

public ObjectInstance registerMBean(java.lang.String className,
                                    ObjectName name)
                             throws InstanceAlreadyExistsException,
                                    MBeanRegistrationException,
                                    NotCompliantMBeanException

Registers a pre-existing object as an MBean with the MBeanServer using this client through the relevant adaptor. If the object name given is null, the MBean may automatically provide its own name by implementing the MBeanRegistration interface. The call returns the MBean name.

Parameters:

String - The classname of the Java Bean to be registered as an MBean.

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

Returns:

The ObjectInstance for the MBean that has been registered.

Throws:

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

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

NotCompliantMBeanException - This object is not an JMX compliant MBean

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object passed in parameter is null or no object name is specified.

registerMBean

public ObjectInstance registerMBean(java.lang.Object object,
                                    ObjectName objectName)
                             throws InstanceAlreadyExistsException,
                                    MBeanRegistrationException,
                                    NotCompliantMBeanException

Description copied from interface: MBeanServer

Registers a pre-existing object as an MBean with the MBean server. If the object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

Tags copied from interface: MBeanServer

Parameters:

object - The MBean to be registered as an MBean.

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

Returns:

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

Throws:

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

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.

registerAsModelMBean

public ObjectInstance registerAsModelMBean(java.lang.Object mbean,
                                           java.lang.String xmlFile,
                                           ObjectName name)
                                    throws InstanceAlreadyExistsException,
                                           MBeanRegistrationException,
                                           NotCompliantMBeanException

Remote method call which registers the MBean. If the passed mbean object is String instance (i.e classname), then this mbean will be instantiated locally as modelmbean in the mbean server and registered. If not instance of java.lang.String class, then this object will be considered as remote modelmbean object. If the mbean object is java.lang.String instance, then the xmlFile means the path of the xml file name locally in the mbean server. If not then the String object of xmlFile will contain the complete xml file.

Parameters:

mbean - The mbean object which is to be instantiated locally as modelmbean in the mbean server and registered.

xmlFile - The path of the xml file name locally in the mbean server.

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

Returns:

The ObjectInstance for the MBean that has been registered.

Throws:

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

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

NotCompliantMBeanException - This object is not an JMX compliant MBean

RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object passed in parameter is null or no object name is specified.

removeNotificationListener

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

Enables a listener for an MBean to be removed using this client through the relevant adaptor.

Parameters:

name - The name of the MBean on which the listener should be removed

listener - The listener object which will handles notifications emitted by the registered MBean.This method will remove all information related to this listener.

Throws:

InstanceNotFoundException - The MBean name doesn't correspond to a registered MBean.

ListenerNotFoundException - The couple (listener,handback) is not registered in the MBean. The exception message contains either "listener", "handback" or the object name depending on which object cannot be found.

removeNotificationListener

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

Enables a listener for an MBean to be removed using this client through the relevant adaptor.

Parameters:

name - The name of the MBean on which the listener should be removed

listener - The listener name which will handles notifications emitted by the registered MBean. This method will remove all information related to this listener.

Throws:

InstanceNotFoundException - The MBean name or the listener name doesn't correspond to a registered MBean

ListenerNotFoundException - The couple (listener,handback) is not registered in the MBean. The exception message contains either "listener", "handback" or the object name depending on which object cannot be found.

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       ObjectName listener,
                                       NotificationFilter filter,
                                       java.lang.Object handback)
                                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.

Parameters:

name - - The name of the MBean on which the listener should be removed.

listener - - A listener that was previously added to this MBean.

filter - - The filter that was specified when the listener was added.

handback - - The handback that was specified when the listener was added.

Throws:

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

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

removeNotificationListener

public void removeNotificationListener(ObjectName name,
                                       NotificationListener listener,
                                       NotificationFilter filter,
                                       java.lang.Object handback)
                                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.

Parameters:

name - - The name of the MBean on which the listener should be removed.

listener - - A listener that was previously added to this MBean.

filter - - The filter that was specified when the listener was added.

handback - - The handback that was specified when the listener was added.

Throws:

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

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

setAttribute

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

Sets the value of a specific attribute of a named MBean using this client through the relevant adaptor. The MBean is identified by its object name.

Parameters:

name - The name of the MBean within which the attribute is to be set.

attribute - The identification of the attribute to be set and the value it is to be set to.

Throws:

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

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

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

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

ReflectionException - Wraps an java.lang.Exception thrown while 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.

setAttributes

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

Sets the values of several attributes of a named MBean using this client through the relevant adaptor. The MBean is identified by its object name.

Parameters:

name - The object name of the MBean within which the attributes are to be set.

attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.

Returns:

The list of attributes that were set, with their new values.

Throws:

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

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.

unregisterMBean

public void unregisterMBean(ObjectName name)
                     throws InstanceNotFoundException,
                            MBeanRegistrationException

De-registers an MBean from the MBeanServer using this client through the relevant adaptor. 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.

Parameters:

name - The object name of the MBean to be de-registered.

Throws:

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

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 de-register is the MBeanServerDelegate MBean.

getClassLoaderRepository

public ClassLoaderRepository getClassLoaderRepository()

Return the ClassLoaderRepository for this MBeanServer.

Returns:

The ClassLoaderRepository for this MBeanServer.

getClassLoader

public java.lang.ClassLoader getClassLoader(ObjectName loaderName)
                                     throws InstanceNotFoundException

Return the named ClassLoader.

Parameters:

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

Returns:

The named ClassLoader. If l is the actual ClassLoader with that name, and r is the returned value, then either:
r is identical to l; or
the result of r.loadClass(s) is the same as l.loadClass(s) for any string s.
What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.

Throws:

InstanceNotFoundException - - if the named ClassLoader is not found.

getClassLoaderFor

public java.lang.ClassLoader getClassLoaderFor(ObjectName mbeanName)
                                        throws InstanceNotFoundException

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

Parameters:

mbeanName - - The ObjectName of the MBean.

Returns:

The ClassLoader used for that MBean. If l is the MBean's actual ClassLoader, and r is the returned value, then either:
r is identical to l; or
the result of r.loadClass(s) is the same as l.loadClass(s) for any string s.
What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.

Throws:

InstanceNotFoundException - - if the named MBean is not found.