|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This RMI interface defines a server access interface for accessing/creating remote server objects by the RMI client from the RMI server.
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 |
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). |
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.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 className,
java.lang.String xmlFileName,
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 |
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 |
unregisterMBean(ObjectName objectName)
Remote method call which de-registers an MBean from the MBeanServer. |
Method Detail |
public void authenticate(com.adventnet.agent.security.UserContext userContext) throws com.adventnet.agent.security.AuthenticationException, java.rmi.RemoteException
userContext
- The UserContext containing the users to be authenticatedcom.adventnet.agent.security.AuthenticationException
- when Authentication fails for a userpublic boolean isAuthenticationEnabled() throws java.rmi.RemoteException
public java.util.Set queryMBeans(ObjectName name, QueryExp query) throws java.rmi.RemoteException
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.public java.util.Set queryNames(ObjectName name, QueryExp query) throws java.rmi.RemoteException
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.public ObjectInstance registerMBean(java.lang.String className, ObjectName objectName) throws java.rmi.RemoteException
String
- The classname of the Java Bean to be registered as an MBean.name
- The object name of the MBean. May be null.public ObjectInstance registerAsModelMBean(java.lang.Object className, java.lang.String xmlFileName, ObjectName objectName) throws java.rmi.RemoteException
public void unregisterMBean(ObjectName objectName) throws java.rmi.RemoteException
name
- The object name of the MBean to be de-registered.public java.lang.Object getAttribute(ObjectName name, java.lang.String attribute) throws java.rmi.RemoteException
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.public AttributeList getAttributes(ObjectName name, java.lang.String[] attributes) throws java.rmi.RemoteException
name
- The object name of the MBean from which the
attributes are to be retrieved.attributes
- A list of the attributes to be retrieved.public java.lang.Object invoke(ObjectName name, java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) throws java.rmi.RemoteException
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 invokedsignature
- 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.public void setAttribute(ObjectName name, Attribute attribute) throws java.rmi.RemoteException
name
- The name of the MBean within which the
attribute is to be set.attribute
- The identification of the attribute to
be set and the value it is to be set to.InstanceNotFoundException
- The
specified MBean is not registered in the MBeanServer.public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws java.rmi.RemoteException
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.public MBeanInfo getMBeanInfo(ObjectName name) throws java.rmi.RemoteException
name
- The name of the MBean to analyzepublic void addRemoteNotificationListener(ObjectName name, RemoteNotificationListener listener, RemoteNotificationFilter filter, java.lang.Object handback) throws java.rmi.RemoteException
name
- the ObjectName of the MBean to analyzelistener
- 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.public void addRemoteNotificationListener(ObjectName name, ObjectName listener, RemoteNotificationFilter filter, java.lang.Object handback) throws java.rmi.RemoteException
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.public void removeRemoteNotificationListener(ObjectName name, RemoteNotificationListener listener) throws java.rmi.RemoteException
name
- the ObjectName of the MBean to analyzelistener
- The listener object which will handles notifications emitted by the
registered MBean.public void removeRemoteNotificationListener(ObjectName name, ObjectName listener) throws java.rmi.RemoteException
name
- the ObjectName of the MBean to analyzelistener
- The listener object name which will handles notifications emitted by the
registered MBean.public ObjectInstance createMBean(java.lang.String className, ObjectName name) throws java.rmi.RemoteException
className
- The class name of the MBean to be instantiated.name
- The object name of the MBean. May be null.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 exceptionNotCompliantMBeanException
- This class is not an
JMX compliant MBeanRuntimeOperationsException
- 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.public ObjectInstance createMBean(java.lang.String className, ObjectName name, java.lang.Object[] params, java.lang.String[] signature) throws java.rmi.RemoteException
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.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 exceptionRuntimeOperationsException
- 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.public ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName) throws java.rmi.RemoteException
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.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 exceptionNotCompliantMBeanException
- This class is not an
JMX compliant MBeanInstanceNotFoundException
- 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.public ObjectInstance createMBean(java.lang.String className, ObjectName name, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws java.rmi.RemoteException
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.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 exceptionRuntimeOperationsException
- 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.public java.lang.String getDefaultDomain() throws java.rmi.RemoteException
public java.lang.Integer getMBeanCount() throws java.rmi.RemoteException
public ObjectInstance getObjectInstance(ObjectName name) throws java.rmi.RemoteException
name
- The object name of the MBean.InstanceNotFoundException
- The MBean specified
is not registered in the MBean server.public java.lang.Object instantiate(java.lang.String className) throws java.rmi.RemoteException
className
- The class name of the object to be instantiated.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 exceptionRuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException: The className passed in parameter is null.public java.lang.Object instantiate(java.lang.String className, java.lang.Object[] params, java.lang.String[] signature) throws java.rmi.RemoteException
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.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 exceptionRuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException: The className passed in parameter is null.public java.lang.Object instantiate(java.lang.String className, ObjectName loaderName) throws java.rmi.RemoteException
className
- The class name of the object to be instantiated.loaderName
- The object name of the class loader to be used.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 exceptionInstanceNotFoundException
- The specified class
loader is not registered in the MBeanServer.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException: The className passed in parameter is null.public java.lang.Object instantiate(java.lang.String className, ObjectName loaderName, java.lang.Object[] params, java.lang.String[] signature) throws java.rmi.RemoteException
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.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 exceptionInstanceNotFoundException
- The specified class
loader is not registered in the MBeanServer.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException: The className passed in parameter is null.public boolean isRegistered(ObjectName name) throws java.rmi.RemoteException
name
- The object name of the MBean to be checked.RuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException: The ObjectName parameter is null.public boolean isInstanceOf(ObjectName name, java.lang.String className) throws java.rmi.RemoteException
name
- The object name of the MBean to be checked.className
- The name of the class.InstanceNotFoundException
- The MBean specified is not registered in the MBean server.public ObjectInstance registerMBean(java.lang.Object object, ObjectName name) throws java.rmi.RemoteException
object
- The Java Bean to be registered as an MBean.name
- The object name of the MBean. May be null.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 MBeanRuntimeOperationsException
- Wraps a
java.lang.IllegalArgumentException: The object passed in parameter is null
or no object name is specified.
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |