XMOJO 5 API Docs

com.adventnet.adaptors.rmi
Class RemoteMBeanServerImpl

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--com.adventnet.adaptors.rmi.RemoteMBeanServerImpl
All Implemented Interfaces:
java.rmi.Remote, RemoteMBeanServer, java.io.Serializable

public class RemoteMBeanServerImpl
extends java.rmi.server.RemoteServer
implements RemoteMBeanServer

This class acts as the factory for the Corba Adaptor clients.

See Also:
Serialized Form

Fields inherited from class java.rmi.server.RemoteObject
ref
 
Constructor Summary
RemoteMBeanServerImpl(MBeanServer server)
          This one Arg constructor gets the mbean server reference.Initialises the UserContext with default values.
 
Method Summary
 void addRemoteNotificationListener(ObjectName name, ObjectName listener, RemoteNotificationFilter 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 addRemoteNotificationListener(ObjectName name, RemoteNotificationListener listener, RemoteNotificationFilter filter, java.lang.Object handback)
          Enables a couple (listener,handback) for a registered MBean to be added.
 void addUser(com.adventnet.agent.security.UserContext userContext)
          Adds the users specified in the UserContext to the Authentication List of the Adaptor
 void authenticate(com.adventnet.agent.security.UserContext userContext)
          Authenticates the users specified in the UserContext
 ObjectInstance createMBean(java.lang.String className, ObjectName name)
          Instantiates and registers a MBean with the MBeanServer through this service(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 through this service(adaptor).
 ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName)
          Instantiates and registers a MBean with the MBeanServer through this service(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 through this service(adaptor).
 void enableAuthentication(boolean authenticate)
          Enables Authentication for the RMI Adaptor
 void enableAuthorisation(boolean authorise)
          Enables Authorisation for the RMI Adaptor
 java.lang.Object getAttribute(ObjectName name, java.lang.String attribute)
          Remote method call which gets the value of a specific attribute of a named MBean.
 AttributeList getAttributes(ObjectName name, java.lang.String[] attributes)
          Remote method call which 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 controlled by the MBeanServer through this service(adaptor).
 MBeanInfo getMBeanInfo(ObjectName name)
          Remote method call which 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 through this service(adaptor).
 java.lang.String getPersistantName()
          Returns the name of the serialized file in which the UserContext details are stored.
 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) through this service(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) through this service(adaptor).
 java.lang.Object instantiate(java.lang.String className, ObjectName loaderName)
          Instantiates an object using the class Loader specified by its ObjectName through this service(adaptor).
 java.lang.Object instantiate(java.lang.String className, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature)
          Instantiates an object through this service(adaptor).
 java.lang.Object invoke(ObjectName name, java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature)
          Remote method call which invokes an action on an MBean.
 boolean isAuthenticationEnabled()
          Determines whether Authentication is enabled or not
 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 through this service(adaptor).
 java.util.Set queryMBeans(ObjectName name, QueryExp query)
          Remote method call to get the MBeans controlled by the MBeanServer.
 java.util.Set queryNames(ObjectName name, QueryExp query)
          Remote method call to get the names of MBeans controlled by the MBeanServer.
 ObjectInstance registerAsModelMBean(java.lang.Object mbean, java.lang.String xmlFile, ObjectName objectName)
          Remote method call which registers the MBean.
 ObjectInstance registerMBean(java.lang.Object object, ObjectName name)
          Registers a pre-existing object as an MBean with the MBeanServer through this service(adaptor).
 ObjectInstance registerMBean(java.lang.String className, ObjectName objectName)
          Remote method call which registers a pre-existing object as an MBean with the MBeanServer.
 void removeRemoteNotificationListener(ObjectName name, ObjectName listener)
          Enables a remote listener for an MBean to be removed.
 void removeRemoteNotificationListener(ObjectName name, RemoteNotificationListener listener)
          Enables a remote listener for an MBean to be removed.
 void removeUser(com.adventnet.agent.security.UserContext userContext)
          Removed the users specified in the UserContext from the Authentication List of the Adaptor
 void setAttribute(ObjectName name, Attribute attribute)
          Remote method call which sets the value of a specific attribute of a named MBean.
 AttributeList setAttributes(ObjectName name, AttributeList attributes)
          Remote method call which sets the values of several attributes of a named MBean.
 void setPersistantName(java.lang.String fileName)
          Sets the file name of the serialized file in which the UserContext details are stored.
 void unregisterMBean(ObjectName objectName)
          Remote method call which de-registers an MBean from the MBeanServer.
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RemoteMBeanServerImpl

public RemoteMBeanServerImpl(MBeanServer server)
                      throws java.rmi.RemoteException
This one Arg constructor gets the mbean server reference.Initialises the UserContext with default values.
Parameters:
server - The MBeanServer reference
Method Detail

authenticate

public void authenticate(com.adventnet.agent.security.UserContext userContext)
                  throws com.adventnet.agent.security.AuthenticationException,
                         java.rmi.RemoteException
Description copied from interface: RemoteMBeanServer
Authenticates the users specified in the UserContext
Specified by:
authenticate in interface RemoteMBeanServer
Following copied from interface: com.adventnet.adaptors.rmi.RemoteMBeanServer
Parameters:
userContext - The UserContext containing the users to be authenticated
Throws:
com.adventnet.agent.security.AuthenticationException - when Authentication fails for a user

addUser

public void addUser(com.adventnet.agent.security.UserContext userContext)
Adds the users specified in the UserContext to the Authentication List of the Adaptor
Parameters:
userContext - The UserContext to be added

removeUser

public void removeUser(com.adventnet.agent.security.UserContext userContext)
Removed the users specified in the UserContext from the Authentication List of the Adaptor
Parameters:
userContext - The UserContext to be removed

setPersistantName

public void setPersistantName(java.lang.String fileName)
Sets the file name of the serialized file in which the UserContext details are stored.
Parameters:
fileName - The name of the file in which the UserContext details are stored

getPersistantName

public java.lang.String getPersistantName()
Returns the name of the serialized file in which the UserContext details are stored.
Returns:
The name of the file in which the UserContext details are stored

isAuthenticationEnabled

public boolean isAuthenticationEnabled()
                                throws java.rmi.RemoteException
Determines whether Authentication is enabled or not
Specified by:
isAuthenticationEnabled in interface RemoteMBeanServer
Returns:
true if Authentication is enabled else returns false

enableAuthentication

public void enableAuthentication(boolean authenticate)
Enables Authentication for the RMI Adaptor
Parameters:
authenticate - Enables Authentication if the value is true

enableAuthorisation

public void enableAuthorisation(boolean authorise)
Enables Authorisation for the RMI Adaptor
Parameters:
authorise - Enables Authorisation if the value is true

queryMBeans

public java.util.Set queryMBeans(ObjectName name,
                                 QueryExp query)
                          throws java.rmi.RemoteException
Remote method call to get the MBeans controlled by the MBeanServer. 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.
Specified by:
queryMBeans in interface RemoteMBeanServer
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)
                         throws java.rmi.RemoteException
Remote method call to get the names of MBeans controlled by the MBeanServer. 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.
Specified by:
queryNames in interface RemoteMBeanServer
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 objectName)
                             throws java.rmi.RemoteException
Remote method call which registers a pre-existing object as an MBean with the MBeanServer. 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.
Specified by:
registerMBean in interface RemoteMBeanServer
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.

registerAsModelMBean

public ObjectInstance registerAsModelMBean(java.lang.Object mbean,
                                           java.lang.String xmlFile,
                                           ObjectName objectName)
                                    throws java.rmi.RemoteException
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.
Specified by:
registerAsModelMBean in interface RemoteMBeanServer
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.

unregisterMBean

public void unregisterMBean(ObjectName objectName)
                     throws java.rmi.RemoteException
Remote method call which de-registers an MBean from the MBeanServer. The MBean is identified by its object name. Once the method has been invoked, the MBean may no longer be accessed by its object name.
Specified by:
unregisterMBean in interface RemoteMBeanServer
Parameters:
name - The object name of the MBean to be de-registered.

getAttribute

public java.lang.Object getAttribute(ObjectName name,
                                     java.lang.String attribute)
                              throws java.rmi.RemoteException
Remote method call which gets the value of a specific attribute of a named MBean. The MBean is identified by its object name.
Specified by:
getAttribute in interface RemoteMBeanServer
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.

getAttributes

public AttributeList getAttributes(ObjectName name,
                                   java.lang.String[] attributes)
                            throws java.rmi.RemoteException
Remote method call which enables the values of several attributes of a named MBean. The MBean is identified by its object name.
Specified by:
getAttributes in interface RemoteMBeanServer
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.

invoke

public java.lang.Object invoke(ObjectName name,
                               java.lang.String actionName,
                               java.lang.Object[] params,
                               java.lang.String[] signature)
                        throws java.rmi.RemoteException
Remote method call which invokes an action on an MBean.
Specified by:
invoke in interface RemoteMBeanServer
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.

setAttribute

public void setAttribute(ObjectName name,
                         Attribute attribute)
                  throws java.rmi.RemoteException
Remote method call which sets the value of a specific attribute of a named MBean. The MBean is identified by its object name.
Specified by:
setAttribute in interface RemoteMBeanServer
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.

setAttributes

public AttributeList setAttributes(ObjectName name,
                                   AttributeList attributes)
                            throws java.rmi.RemoteException
Remote method call which sets the values of several attributes of a named MBean. The MBean is identified by its object name.
Specified by:
setAttributes in interface RemoteMBeanServer
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.

getMBeanInfo

public MBeanInfo getMBeanInfo(ObjectName name)
                       throws java.rmi.RemoteException
Remote method call which discovers the attributes and operations that an MBean exposes for management. When flatten is false, inherited attributes are not returned.
Specified by:
getMBeanInfo in interface RemoteMBeanServer
Parameters:
name - The name of the MBean to analyze
Returns:
An instance of MBeanInfo allowing to retrieve all attributes and operations of this MBean.

addRemoteNotificationListener

public void addRemoteNotificationListener(ObjectName name,
                                          RemoteNotificationListener listener,
                                          RemoteNotificationFilter filter,
                                          java.lang.Object handback)
                                   throws java.rmi.RemoteException
Enables a couple (listener,handback) for a registered MBean to be added.
Specified by:
addRemoteNotificationListener in interface RemoteMBeanServer
Parameters:
name - the ObjectName of the MBean to analyze
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.

addRemoteNotificationListener

public void addRemoteNotificationListener(ObjectName name,
                                          ObjectName listener,
                                          RemoteNotificationFilter filter,
                                          java.lang.Object handback)
                                   throws java.rmi.RemoteException
Enables a couple (listener,handback) for a registered MBean to be added using this client through the relevant adaptor.
Specified by:
addRemoteNotificationListener in interface RemoteMBeanServer
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.

removeRemoteNotificationListener

public void removeRemoteNotificationListener(ObjectName name,
                                             RemoteNotificationListener listener)
                                      throws java.rmi.RemoteException
Enables a remote listener for an MBean to be removed. All couple (listener, handback) are removed.
Specified by:
removeRemoteNotificationListener in interface RemoteMBeanServer
Parameters:
name - the ObjectName of the MBean to analyze
listener - The listener object which will handles notifications emitted by the registered MBean.

removeRemoteNotificationListener

public void removeRemoteNotificationListener(ObjectName name,
                                             ObjectName listener)
                                      throws java.rmi.RemoteException
Enables a remote listener for an MBean to be removed. All couple (listener, handback) are removed.
Specified by:
removeRemoteNotificationListener in interface RemoteMBeanServer
Parameters:
name - the ObjectName of the MBean to analyze
listener - The listener object name which will handles notifications emitted by the registered MBean.

createMBean

public ObjectInstance createMBean(java.lang.String className,
                                  ObjectName name)
                           throws java.rmi.RemoteException
Instantiates and registers a MBean with the MBeanServer through this service(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.
Specified by:
createMBean in interface RemoteMBeanServer
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 java.rmi.RemoteException
Instantiates and registers a MBean with the MBeanServer through this service(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.
Specified by:
createMBean in interface RemoteMBeanServer
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
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 java.rmi.RemoteException
Instantiates and registers a MBean with the MBeanServer through this service(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.
Specified by:
createMBean in interface RemoteMBeanServer
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 java.rmi.RemoteException
Instantiates and registers a MBean with the MBeanServer through this service(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.
Specified by:
createMBean in interface RemoteMBeanServer
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
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.

getDefaultDomain

public java.lang.String getDefaultDomain()
                                  throws java.rmi.RemoteException
Returns the default domain used for naming the MBean. through this service(adaptor). The default domain name is used as the domain part in the ObjectName of MBeans if no domain is specified by the user.
Specified by:
getDefaultDomain in interface RemoteMBeanServer
Returns:
The default domain used for naming the MBean. through this service(adaptor).

getMBeanCount

public java.lang.Integer getMBeanCount()
                                throws java.rmi.RemoteException
Returns the number of MBeans controlled by the MBeanServer through this service(adaptor).
Specified by:
getMBeanCount in interface RemoteMBeanServer
Returns:
The number of MBeans controlled by the MBeanServer through this service(adaptor).

getObjectInstance

public ObjectInstance getObjectInstance(ObjectName name)
                                 throws java.rmi.RemoteException
Gets the ObjectInstance for a given MBean registered with the MBean server through this service(adaptor).
Specified by:
getObjectInstance in interface RemoteMBeanServer
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 java.rmi.RemoteException
Instantiates an object using the list of all class loaders registered in the MBean server (Default Loader Repository) through this service(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.
Specified by:
instantiate in interface RemoteMBeanServer
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 java.rmi.RemoteException
Instantiates an object using the list of all class loaders registered in the MBean server (Default Loader Repository) through this service(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.
Specified by:
instantiate in interface RemoteMBeanServer
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 java.rmi.RemoteException
Instantiates an object using the class Loader specified by its ObjectName through this service(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.
Specified by:
instantiate in interface RemoteMBeanServer
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 java.rmi.RemoteException
Instantiates an object through this service(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.
Specified by:
instantiate in interface RemoteMBeanServer
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.

isRegistered

public boolean isRegistered(ObjectName name)
                     throws java.rmi.RemoteException
Checks whether an MBean, identified by its object name, is already registered with the MBeanServer through this service(adaptor).
Specified by:
isRegistered in interface RemoteMBeanServer
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 java.rmi.RemoteException
Returns true if the MBean specified is an instance of the specified class, false otherwise.
Specified by:
isInstanceOf in interface RemoteMBeanServer
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 MBeanserver.

registerMBean

public ObjectInstance registerMBean(java.lang.Object object,
                                    ObjectName name)
                             throws java.rmi.RemoteException
Registers a pre-existing object as an MBean with the MBeanServer through this service(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.
Specified by:
registerMBean in interface RemoteMBeanServer
Parameters:
object - 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.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.