Interface RMIConnection
- All Superinterfaces:
AutoCloseable,Closeable,Remote
- All Known Implementing Classes:
RMIConnectionImpl,RMIConnectionImpl_Stub
RMI object used to forward an MBeanServer request from a client to its MBeanServer implementation on the server side. There is one Remote object implementing this interface for each remote client connected to an RMI connector.
User code does not usually refer to this interface. It is specified as part of the public API so that different implementations of that API will interoperate.
To ensure that client parameters will be deserialized at the
server side with the correct classloader, client parameters such as
parameters used to invoke a method are wrapped in a MarshalledObject. An implementation of this interface must first
get the appropriate class loader for the operation and its target,
then deserialize the marshalled parameters with this classloader.
Except as noted, a parameter that is a
MarshalledObject or MarshalledObject[]
must not be null; the behavior is unspecified if it is.
Class loading aspects are detailed in the JMX Specification, version 1.4
Most methods in this interface parallel methods in the MBeanServerConnection interface. Where an aspect of the behavior
of a method is not specified here, it is the same as in the
corresponding MBeanServerConnection method.
JMX Subject Delegation has been removed. All methods that take a
delegationSubject parameter will throw UnsupportedOperationException
if it is non-null. This parameter is kept for interoperability with older
remote clients.
- Since:
- 1.5
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddNotificationListener(ObjectName name, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject) Integer[]addNotificationListeners(ObjectName[] names, MarshalledObject[] filters, Subject[] delegationSubjects) voidclose()Closes this connection.createMBean(String className, ObjectName name, MarshalledObject params, String[] signature, Subject delegationSubject) Handles the methodMBeanServerConnection.createMBean(String, ObjectName, Object[], String[]).createMBean(String className, ObjectName name, ObjectName loaderName, MarshalledObject params, String[] signature, Subject delegationSubject) createMBean(String className, ObjectName name, ObjectName loaderName, Subject delegationSubject) Handles the methodMBeanServerConnection.createMBean(String, ObjectName, ObjectName).createMBean(String className, ObjectName name, Subject delegationSubject) Handles the methodMBeanServerConnection.createMBean(String, ObjectName).fetchNotifications(long clientSequenceNumber, int maxNotifications, long timeout) Retrieves notifications from the connector server.getAttribute(ObjectName name, String attribute, Subject delegationSubject) Handles the methodMBeanServerConnection.getAttribute(ObjectName, String).getAttributes(ObjectName name, String[] attributes, Subject delegationSubject) Handles the methodMBeanServerConnection.getAttributes(ObjectName, String[]).Returns the connection ID.getDefaultDomain(Subject delegationSubject) Handles the methodMBeanServerConnection.getDefaultDomain().String[]getDomains(Subject delegationSubject) Handles the methodMBeanServerConnection.getDomains().getMBeanCount(Subject delegationSubject) Handles the methodMBeanServerConnection.getMBeanCount().getMBeanInfo(ObjectName name, Subject delegationSubject) Handles the methodMBeanServerConnection.getMBeanInfo(ObjectName).getObjectInstance(ObjectName name, Subject delegationSubject) Handles the methodMBeanServerConnection.getObjectInstance(ObjectName).invoke(ObjectName name, String operationName, MarshalledObject params, String[] signature, Subject delegationSubject) Handles the methodMBeanServerConnection.invoke(ObjectName, String, Object[], String[]).booleanisInstanceOf(ObjectName name, String className, Subject delegationSubject) Handles the methodMBeanServerConnection.isInstanceOf(ObjectName, String).booleanisRegistered(ObjectName name, Subject delegationSubject) Handles the methodMBeanServerConnection.isRegistered(ObjectName).queryMBeans(ObjectName name, MarshalledObject query, Subject delegationSubject) Handles the methodMBeanServerConnection.queryMBeans(ObjectName, QueryExp).queryNames(ObjectName name, MarshalledObject query, Subject delegationSubject) Handles the methodMBeanServerConnection.queryNames(ObjectName, QueryExp).voidremoveNotificationListener(ObjectName name, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject) voidremoveNotificationListener(ObjectName name, ObjectName listener, Subject delegationSubject) Handles the methodMBeanServerConnection.removeNotificationListener(ObjectName, ObjectName).voidremoveNotificationListeners(ObjectName name, Integer[] listenerIDs, Subject delegationSubject) voidsetAttribute(ObjectName name, MarshalledObject attribute, Subject delegationSubject) Handles the methodMBeanServerConnection.setAttribute(ObjectName, Attribute).setAttributes(ObjectName name, MarshalledObject attributes, Subject delegationSubject) Handles the methodMBeanServerConnection.setAttributes(ObjectName, AttributeList).voidunregisterMBean(ObjectName name, Subject delegationSubject) Handles the methodMBeanServerConnection.unregisterMBean(ObjectName).
-
Method Details
-
getConnectionId
Returns the connection ID. This string is different for every open connection to a given RMI connector server.
- Returns:
- the connection ID
- Throws:
IOException- if a general communication exception occurred.- See Also:
-
close
Closes this connection. On return from this method, the RMI object implementing this interface is unexported, so further remote calls to it will fail.
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException- if the connection could not be closed, or the Remote object could not be unexported, or there was a communication failure when transmitting the remote close request.
-
createMBean
ObjectInstance createMBean(String className, ObjectName name, Subject delegationSubject) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, IOException Handles the methodMBeanServerConnection.createMBean(String, ObjectName).- Parameters:
className- The class name of the MBean to be instantiated.name- The object name of the MBean. May be null.delegationSubject- must benull.- Returns:
- An
ObjectInstance, containing theObjectNameand the Java class name of the newly instantiated MBean. If the containedObjectNameisn, the contained Java class name is.getMBeanInfo(n).getClassName() - Throws:
ReflectionException- Wraps ajava.lang.ClassNotFoundExceptionor ajava.lang.Exceptionthat occurred when trying to invoke the MBean's constructor.InstanceAlreadyExistsException- The MBean is already under the control of the MBean server.MBeanRegistrationException- ThepreRegister(MBeanRegistrationinterface) method of the MBean has thrown an exception. The MBean will not be registered.MBeanException- The constructor of the MBean has thrown an exception.NotCompliantMBeanException- This class is not a JMX compliant MBean.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The className passed in parameter is null, theObjectNamepassed in parameter contains a pattern or noObjectNameis specified for the MBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
createMBean
ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Subject delegationSubject) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException Handles the methodMBeanServerConnection.createMBean(String, ObjectName, ObjectName).- 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.delegationSubject- must benull.- Returns:
- An
ObjectInstance, containing theObjectNameand the Java class name of the newly instantiated MBean. If the containedObjectNameisn, the contained Java class name is.getMBeanInfo(n).getClassName() - Throws:
ReflectionException- Wraps ajava.lang.ClassNotFoundExceptionor ajava.lang.Exceptionthat occurred when trying to invoke the MBean's constructor.InstanceAlreadyExistsException- The MBean is already under the control of the MBean server.MBeanRegistrationException- ThepreRegister(MBeanRegistrationinterface) method of the MBean has thrown an exception. The MBean will not be registered.MBeanException- The constructor of the MBean has thrown an exception.NotCompliantMBeanException- This class is not a JMX compliant MBean.InstanceNotFoundException- The specified class loader is not registered in the MBean server.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The className passed in parameter is null, theObjectNamepassed in parameter contains a pattern or noObjectNameis specified for the MBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
createMBean
ObjectInstance createMBean(String className, ObjectName name, MarshalledObject params, String[] signature, Subject delegationSubject) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, IOException Handles the methodMBeanServerConnection.createMBean(String, ObjectName, Object[], String[]). TheObject[]parameter is wrapped in aMarshalledObject.- 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, encapsulated into aMarshalledObject. The encapsulated array can be null, equivalent to an empty array.signature- An array containing the signature of the constructor to be invoked. Can be null, equivalent to an empty array.delegationSubject- must benull.- Returns:
- An
ObjectInstance, containing theObjectNameand the Java class name of the newly instantiated MBean. If the containedObjectNameisn, the contained Java class name is.getMBeanInfo(n).getClassName() - Throws:
ReflectionException- Wraps ajava.lang.ClassNotFoundExceptionor ajava.lang.Exceptionthat occurred when trying to invoke the MBean's constructor.InstanceAlreadyExistsException- The MBean is already under the control of the MBean server.MBeanRegistrationException- ThepreRegister(MBeanRegistrationinterface) method of the MBean has thrown an exception. The MBean will not be registered.MBeanException- The constructor of the MBean has thrown an exception.NotCompliantMBeanException- This class is not a JMX compliant MBean.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The className passed in parameter is null, theObjectNamepassed in parameter contains a pattern, or noObjectNameis specified for the MBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
createMBean
ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, MarshalledObject params, String[] signature, Subject delegationSubject) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException Handles the methodMBeanServerConnection.createMBean(String, ObjectName, ObjectName, Object[], String[]). TheObject[]parameter is wrapped in aMarshalledObject.- 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.params- An array containing the parameters of the constructor to be invoked, encapsulated into aMarshalledObject. The encapsulated array can be null, equivalent to an empty array.signature- An array containing the signature of the constructor to be invoked. Can be null, equivalent to an empty array.delegationSubject- must benull.- Returns:
- An
ObjectInstance, containing theObjectNameand the Java class name of the newly instantiated MBean. If the containedObjectNameisn, the contained Java class name is.getMBeanInfo(n).getClassName() - Throws:
ReflectionException- Wraps ajava.lang.ClassNotFoundExceptionor ajava.lang.Exceptionthat occurred when trying to invoke the MBean's constructor.InstanceAlreadyExistsException- The MBean is already under the control of the MBean server.MBeanRegistrationException- ThepreRegister(MBeanRegistrationinterface) method of the MBean has thrown an exception. The MBean will not be registered.MBeanException- The constructor of the MBean has thrown an exception.NotCompliantMBeanException- This class is not a JMX compliant MBean.InstanceNotFoundException- The specified class loader is not registered in the MBean server.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The className passed in parameter is null, theObjectNamepassed in parameter contains a pattern, or noObjectNameis specified for the MBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
unregisterMBean
void unregisterMBean(ObjectName name, Subject delegationSubject) throws InstanceNotFoundException, MBeanRegistrationException, IOException Handles the methodMBeanServerConnection.unregisterMBean(ObjectName).- Parameters:
name- The object name of the MBean to be unregistered.delegationSubject- must benull.- Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.MBeanRegistrationException- The preDeregister (MBeanRegistrationinterface) method of the MBean has thrown an exception.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null or the MBean you are when trying to unregister is theMBeanServerDelegateMBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
getObjectInstance
ObjectInstance getObjectInstance(ObjectName name, Subject delegationSubject) throws InstanceNotFoundException, IOException Handles the methodMBeanServerConnection.getObjectInstance(ObjectName).- Parameters:
name- The object name of the MBean.delegationSubject- must benull.- Returns:
- The
ObjectInstanceassociated with the MBean specified by name. The containedObjectNameisnameand the contained class name is.getMBeanInfo(name).getClassName() - Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
queryMBeans
Set<ObjectInstance> queryMBeans(ObjectName name, MarshalledObject query, Subject delegationSubject) throws IOException Handles the methodMBeanServerConnection.queryMBeans(ObjectName, QueryExp). TheQueryExpis wrapped in aMarshalledObject.- Parameters:
name- The object name pattern identifying the MBeans to be retrieved. If null or no domain and key properties are specified, all the MBeans registered will be retrieved.query- The query expression to be applied for selecting MBeans, encapsulated into aMarshalledObject. If theMarshalledObjectencapsulates a null value no query expression will be applied for selecting MBeans.delegationSubject- must benull.- Returns:
- A set containing the
ObjectInstanceobjects for the selected MBeans. If no MBean satisfies the query an empty list is returned. - Throws:
SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
queryNames
Set<ObjectName> queryNames(ObjectName name, MarshalledObject query, Subject delegationSubject) throws IOException Handles the methodMBeanServerConnection.queryNames(ObjectName, QueryExp). TheQueryExpis wrapped in aMarshalledObject.- Parameters:
name- The object name pattern identifying the MBean names to be retrieved. If null or no domain and key properties are specified, the name of all registered MBeans will be retrieved.query- The query expression to be applied for selecting MBeans, encapsulated into aMarshalledObject. If theMarshalledObjectencapsulates a null value no query expression will be applied for selecting MBeans.delegationSubject- must benull.- Returns:
- A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.
- Throws:
SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
isRegistered
Handles the methodMBeanServerConnection.isRegistered(ObjectName).- Parameters:
name- The object name of the MBean to be checked.delegationSubject- must benull.- Returns:
- True if the MBean is already registered in the MBean server, false otherwise.
- Throws:
RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
getMBeanCount
Handles the methodMBeanServerConnection.getMBeanCount().- Parameters:
delegationSubject- must benull.- Returns:
- the number of MBeans registered.
- Throws:
SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
getAttribute
Object getAttribute(ObjectName name, String attribute, Subject delegationSubject) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException, IOException Handles the methodMBeanServerConnection.getAttribute(ObjectName, String).- 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.delegationSubject- must benull.- Returns:
- The value of the retrieved attribute.
- Throws:
AttributeNotFoundException- The attribute specified is not accessible in the MBean.MBeanException- Wraps an exception thrown by the MBean's getter.InstanceNotFoundException- The MBean specified is not registered in the MBean server.ReflectionException- Wraps ajava.lang.Exceptionthrown when trying to invoke the getter.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.RuntimeMBeanException- Wraps a runtime exception thrown by the MBean's getter.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
getAttributes
AttributeList getAttributes(ObjectName name, String[] attributes, Subject delegationSubject) throws InstanceNotFoundException, ReflectionException, IOException Handles the methodMBeanServerConnection.getAttributes(ObjectName, String[]).- Parameters:
name- The object name of the MBean from which the attributes are retrieved.attributes- A list of the attributes to be retrieved.delegationSubject- must benull.- Returns:
- The list of the retrieved attributes.
- Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.ReflectionException- An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.RuntimeOperationsException- Wrap ajava.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
setAttribute
void setAttribute(ObjectName name, MarshalledObject attribute, Subject delegationSubject) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException, IOException Handles the methodMBeanServerConnection.setAttribute(ObjectName, Attribute). TheAttributeparameter is wrapped in aMarshalledObject.- 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, encapsulated into aMarshalledObject.delegationSubject- must benull.- Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.AttributeNotFoundException- The attribute specified is not accessible in the MBean.InvalidAttributeValueException- The value specified for the attribute is not valid.MBeanException- Wraps an exception thrown by the MBean's setter.ReflectionException- Wraps ajava.lang.Exceptionthrown when trying to invoke the setter.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null or the attribute in parameter is null.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
setAttributes
AttributeList setAttributes(ObjectName name, MarshalledObject attributes, Subject delegationSubject) throws InstanceNotFoundException, ReflectionException, IOException Handles the methodMBeanServerConnection.setAttributes(ObjectName, AttributeList). TheAttributeListparameter is wrapped in aMarshalledObject.- 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, encapsulated into aMarshalledObject.delegationSubject- must benull.- Returns:
- The list of attributes that were set, with their new values.
- Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.ReflectionException- An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
invoke
Object invoke(ObjectName name, String operationName, MarshalledObject params, String[] signature, Subject delegationSubject) throws InstanceNotFoundException, MBeanException, ReflectionException, IOException Handles the methodMBeanServerConnection.invoke(ObjectName, String, Object[], String[]). TheObject[]parameter is wrapped in aMarshalledObject.- Parameters:
name- The object name of the MBean on which the method is to be invoked.operationName- The name of the operation to be invoked.params- An array containing the parameters to be set when the operation is invoked, encapsulated into aMarshalledObject. The encapsulated array can be null, equivalent to an empty array.signature- An array containing the signature of the operation. The class objects will be loaded using the same class loader as the one used for loading the MBean on which the operation was invoked. Can be null, equivalent to an empty array.delegationSubject- must benull.- Returns:
- The object returned by the operation, which represents the result of invoking the operation on the MBean specified.
- Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.MBeanException- Wraps an exception thrown by the MBean's invoked method.ReflectionException- Wraps ajava.lang.Exceptionthrown while trying to invoke the method.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.RuntimeOperationsException- Wraps anIllegalArgumentExceptionwhennameoroperationNameis null.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
getDefaultDomain
Handles the methodMBeanServerConnection.getDefaultDomain().- Parameters:
delegationSubject- must benull.- Returns:
- the default domain.
- Throws:
SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
getDomains
Handles the methodMBeanServerConnection.getDomains().- Parameters:
delegationSubject- must benull.- Returns:
- the list of domains.
- Throws:
SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
getMBeanInfo
MBeanInfo getMBeanInfo(ObjectName name, Subject delegationSubject) throws InstanceNotFoundException, IntrospectionException, ReflectionException, IOException Handles the methodMBeanServerConnection.getMBeanInfo(ObjectName).- Parameters:
name- The name of the MBean to analyzedelegationSubject- must benull.- Returns:
- An instance of
MBeanInfoallowing the retrieval of all attributes and operations of this MBean. - Throws:
IntrospectionException- An exception occurred during introspection.InstanceNotFoundException- The MBean specified was not found.ReflectionException- An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
isInstanceOf
boolean isInstanceOf(ObjectName name, String className, Subject delegationSubject) throws InstanceNotFoundException, IOException Handles the methodMBeanServerConnection.isInstanceOf(ObjectName, String).- Parameters:
name- TheObjectNameof the MBean.className- The name of the class.delegationSubject- must benull.- Returns:
- true if the MBean specified is an instance of the specified class according to the rules above, false otherwise.
- Throws:
InstanceNotFoundException- The MBean specified is not registered in the MBean server.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.RuntimeOperationsException- Wraps ajava.lang.IllegalArgumentException: The object name in parameter is null.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
addNotificationListener
void addNotificationListener(ObjectName name, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject) throws InstanceNotFoundException, IOException Handles the methodMBeanServerConnection.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object). TheNotificationFilterparameter is wrapped in aMarshalledObject. TheObject(handback) parameter is also wrapped in aMarshalledObject.- Parameters:
name- The name of the MBean on which the listener should be added.listener- The object name of the listener which will handle the notifications emitted by the registered MBean.filter- The filter object, encapsulated into aMarshalledObject. If filter encapsulated in theMarshalledObjecthas a null value, no filtering will be performed before handling notifications.handback- The context to be sent to the listener when a notification is emitted, encapsulated into aMarshalledObject.delegationSubject- must benull.- Throws:
InstanceNotFoundException- The MBean name of the notification listener or of the notification broadcaster does not match any of the registered MBeans.RuntimeOperationsException- Wraps anIllegalArgumentException. The MBean named bylistenerexists but does not implement theNotificationListenerinterface, ornameorlisteneris null.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
removeNotificationListener
void removeNotificationListener(ObjectName name, ObjectName listener, Subject delegationSubject) throws InstanceNotFoundException, ListenerNotFoundException, IOException Handles the methodMBeanServerConnection.removeNotificationListener(ObjectName, ObjectName).- Parameters:
name- The name of the MBean on which the listener should be removed.listener- The object name of the listener to be removed.delegationSubject- must benull.- Throws:
InstanceNotFoundException- The MBean name provided does not match any of the registered MBeans.ListenerNotFoundException- The listener is not registered in the MBean.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.RuntimeOperationsException- Wraps anIllegalArgumentExceptionwhennameorlisteneris null.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
removeNotificationListener
void removeNotificationListener(ObjectName name, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject) throws InstanceNotFoundException, ListenerNotFoundException, IOException Handles the methodMBeanServerConnection.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object). TheNotificationFilterparameter is wrapped in aMarshalledObject. TheObjectparameter is also wrapped in aMarshalledObject.- 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, encapsulated into aMarshalledObject.handback- The handback that was specified when the listener was added, encapsulated into aMarshalledObject.delegationSubject- must benull.- 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.SecurityException- if the client is not authorized to perform this operation.IOException- if a general communication exception occurred.RuntimeOperationsException- Wraps anIllegalArgumentExceptionwhennameorlisteneris null.UnsupportedOperationException- ifdelegationSubjectis non-null.- See Also:
-
addNotificationListeners
Integer[] addNotificationListeners(ObjectName[] names, MarshalledObject[] filters, Subject[] delegationSubjects) throws InstanceNotFoundException, IOException Handles the method
MBeanServerConnection.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object).Register for notifications from the given MBeans that match the given filters. The remote client can subsequently retrieve the notifications using the
fetchNotificationsmethod.For each listener, the original
NotificationListenerandhandbackare kept on the client side; in order for the client to be able to identify them, the server generates and returns a uniquelistenerID. ThislistenerIDis forwarded with theNotificationsto the remote client.If any one of the given (name, filter) pairs cannot be registered, then the operation fails with an exception, and no names or filters are registered.
- Parameters:
names- theObjectNamesidentifying the MBeans emitting the Notifications.filters- an array of marshalled representations of theNotificationFilters. Elements of this array can be null.delegationSubjects- must benull, or an array which does not contain any non-null entries.- Returns:
- an array of
listenerIDsidentifying the local listeners. This array has the same number of elements as the parameters. - Throws:
IllegalArgumentException- ifnamesorfiltersis null, or ifnamescontains a null element, or if these two arrays do not have the same size.ClassCastException- if one of the elements offiltersunmarshalls as a non-null object that is not aNotificationFilter.InstanceNotFoundException- if one of thenamesdoes not correspond to any registered MBean.SecurityException- if, for one of the MBeans, the client is not authorized to add a listener.IOException- if a general communication exception occurred.UnsupportedOperationException- ifdelegationSubjectsis non-null and contains any non-null entries.
-
removeNotificationListeners
void removeNotificationListeners(ObjectName name, Integer[] listenerIDs, Subject delegationSubject) throws InstanceNotFoundException, ListenerNotFoundException, IOException Handles the
removeNotificationListener(ObjectName, NotificationListener)andremoveNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)methods.This method removes one or more
NotificationListeners from a given MBean in the MBean server.The
NotificationListenersare identified by the IDs which were returned by theaddNotificationListeners(ObjectName[], MarshalledObject[], Subject[])method.- Parameters:
name- theObjectNameidentifying the MBean emitting the Notifications.listenerIDs- the list of the IDs corresponding to the listeners to remove.delegationSubject- must benull.- Throws:
InstanceNotFoundException- if the givennamedoes not correspond to any registered MBean.ListenerNotFoundException- if one of the listeners was not found on the server side. This exception can happen if the MBean discarded a listener for some reason other than a call toMBeanServer.removeNotificationListener.SecurityException- if the client is not authorized to remove the listeners.IOException- if a general communication exception occurred.IllegalArgumentException- ifObjectNameorlistenerIdsis null or iflistenerIdscontains a null element.UnsupportedOperationException- ifdelegationSubjectis non-null.
-
fetchNotifications
NotificationResult fetchNotifications(long clientSequenceNumber, int maxNotifications, long timeout) throws IOException Retrieves notifications from the connector server. This method can block until there is at least one notification or until the specified timeout is reached. The method can also return at any time with zero notifications.
A notification can be included in the result if its sequence number is no less than
clientSequenceNumberand this client has registered at least one listener for the MBean generating the notification, with a filter that accepts the notification. Each listener that is interested in the notification is identified by an Integer ID that was returned byaddNotificationListeners(ObjectName[], MarshalledObject[], Subject[]).- Parameters:
clientSequenceNumber- the first sequence number that the client is interested in. If negative, it is interpreted as meaning the sequence number that the next notification will have.maxNotifications- the maximum number of different notifications to return. TheTargetedNotificationarray in the returnedNotificationResultcan have more elements than this if the same notification appears more than once. The behavior is unspecified if this parameter is negative.timeout- the maximum time in milliseconds to wait for a notification to arrive. This can be 0 to indicate that the method should not wait if there are no notifications, but should return at once. It can beLong.MAX_VALUEto indicate that there is no timeout. The behavior is unspecified if this parameter is negative.- Returns:
- A
NotificationResult. - Throws:
IOException- if a general communication exception occurred.
-