RMIConnectionImpl (Java Platform SE 8 )
Keywords: javax.management.remote.rmi.RMIConnectionImpl class
Date: 2016-07-28

compact3
javax.management.remote.rmi

## Class RMIConnectionImpl

- java.lang.Object
- - javax.management.remote.rmi.RMIConnectionImpl

- All Implemented Interfaces:
    Closeable, AutoCloseable, Remote, Unreferenced, RMIConnection

      public class RMIConnectionImpl
      extends Object
      implements RMIConnection, Unreferenced

  Implementation of the `RMIConnection` interface. User code will not usually reference this class.

  Since:
    1.5

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `RMIConnectionImpl(RMIServerImpl rmiServer, String connectionId, ClassLoader defaultClassLoader, Subject subject, Map<String,?> env)` Constructs a new `RMIConnection`.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addNotificationListener(ObjectName name, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject)` Handles the method `MBeanServerConnection.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)`.
    `Integer[]` | `addNotificationListeners(ObjectName[] names, MarshalledObject[] filters, Subject[] delegationSubjects)` Handles the method `MBeanServerConnection.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)`.
    `void` | `close()` Closes this connection.
    `ObjectInstance` | `createMBean(String className, ObjectName name, MarshalledObject params, String[] signature, Subject delegationSubject)` Handles the method `MBeanServerConnection.createMBean(String, ObjectName, Object[], String[])`.
    `ObjectInstance` | `createMBean(String className, ObjectName name, ObjectName loaderName, MarshalledObject params, String[] signature, Subject delegationSubject)` Handles the method `MBeanServerConnection.createMBean(String, ObjectName, ObjectName, Object[], String[])`.
    `ObjectInstance` | `createMBean(String className, ObjectName name, ObjectName loaderName, Subject delegationSubject)` Handles the method `MBeanServerConnection.createMBean(String, ObjectName, ObjectName)`.
    `ObjectInstance` | `createMBean(String className, ObjectName name, Subject delegationSubject)` Handles the method `MBeanServerConnection.createMBean(String, ObjectName)`.
    `NotificationResult` | `fetchNotifications(long clientSequenceNumber, int maxNotifications, long timeout)` Retrieves notifications from the connector server.
    `Object` | `getAttribute(ObjectName name, String attribute, Subject delegationSubject)` Handles the method `MBeanServerConnection.getAttribute(ObjectName, String)`.
    `AttributeList` | `getAttributes(ObjectName name, String[] attributes, Subject delegationSubject)` Handles the method `MBeanServerConnection.getAttributes(ObjectName, String[])`.
    `String` | `getConnectionId()` Returns the connection ID.
    `String` | `getDefaultDomain(Subject delegationSubject)` Handles the method `MBeanServerConnection.getDefaultDomain()`.
    `String[]` | `getDomains(Subject delegationSubject)` Handles the method `MBeanServerConnection.getDomains()`.
    `Integer` | `getMBeanCount(Subject delegationSubject)` Handles the method `MBeanServerConnection.getMBeanCount()`.
    `MBeanInfo` | `getMBeanInfo(ObjectName name, Subject delegationSubject)` Handles the method `MBeanServerConnection.getMBeanInfo(ObjectName)`.
    `ObjectInstance` | `getObjectInstance(ObjectName name, Subject delegationSubject)` Handles the method `MBeanServerConnection.getObjectInstance(ObjectName)`.
    `Object` | `invoke(ObjectName name, String operationName, MarshalledObject params, String[] signature, Subject delegationSubject)` Handles the method `MBeanServerConnection.invoke(ObjectName, String, Object[], String[])`.
    `boolean` | `isInstanceOf(ObjectName name, String className, Subject delegationSubject)` Handles the method `MBeanServerConnection.isInstanceOf(ObjectName, String)`.
    `boolean` | `isRegistered(ObjectName name, Subject delegationSubject)` Handles the method `MBeanServerConnection.isRegistered(ObjectName)`.
    `Set<ObjectInstance>` | `queryMBeans(ObjectName name, MarshalledObject query, Subject delegationSubject)` Handles the method `MBeanServerConnection.queryMBeans(ObjectName, QueryExp)`.
    `Set<ObjectName>` | `queryNames(ObjectName name, MarshalledObject query, Subject delegationSubject)` Handles the method `MBeanServerConnection.queryNames(ObjectName, QueryExp)`.
    `void` | `removeNotificationListener(ObjectName name, ObjectName listener, MarshalledObject filter, MarshalledObject handback, Subject delegationSubject)` Handles the method `MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)`.
    `void` | `removeNotificationListener(ObjectName name, ObjectName listener, Subject delegationSubject)` Handles the method `MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName)`.
    `void` | `removeNotificationListeners(ObjectName name, Integer[] listenerIDs, Subject delegationSubject)` Handles the `removeNotificationListener(ObjectName, NotificationListener)` and `removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)` methods.
    `void` | `setAttribute(ObjectName name, MarshalledObject attribute, Subject delegationSubject)` Handles the method `MBeanServerConnection.setAttribute(ObjectName, Attribute)`.
    `AttributeList` | `setAttributes(ObjectName name, MarshalledObject attributes, Subject delegationSubject)` Handles the method `MBeanServerConnection.setAttributes(ObjectName, AttributeList)`.
    `String` | `toString()` Returns a string representation of this object.
    `void` | `unreferenced()` Called by the RMI runtime sometime after the runtime determines that the reference list, the list of clients referencing the remote object, becomes empty.
    `void` | `unregisterMBean(ObjectName name, Subject delegationSubject)` Handles the method `MBeanServerConnection.unregisterMBean(ObjectName)`.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### RMIConnectionImpl

          public RMIConnectionImpl(RMIServerImpl rmiServer,
                                   String connectionId,
                                   ClassLoader defaultClassLoader,
                                   Subject subject,
                                   Map<String,?> env)

      Constructs a new `RMIConnection`. This connection can be used with either the JRMP or IIOP transport. This object does not export itself: it is the responsibility of the caller to export it appropriately (see `RMIJRMPServerImpl.makeClient(String,Subject)` and `RMIIIOPServerImpl.makeClient(String,Subject)`.
      Parameters:
        `rmiServer` - The RMIServerImpl object for which this connection is created. The behavior is unspecified if this parameter is null.
        `connectionId` - The ID for this connection. The behavior is unspecified if this parameter is null.
        `defaultClassLoader` - The default ClassLoader to be used when deserializing marshalled objects. Can be null, to signify the bootstrap class loader.
        `subject` - the authenticated subject to be used for authorization. Can be null, to signify that no subject has been authenticated.
        `env` - the environment containing attributes for the new `RMIServerImpl`. Can be null, equivalent to an empty map.

  - ### Method Detail

    - #### getConnectionId

          public String getConnectionId()
                                 throws IOException

      Description copied from interface: `RMIConnection`

      Returns the connection ID. This string is different for every open connection to a given RMI connector server.

      Specified by:
        `getConnectionId` in interface `RMIConnection`
      Returns:
        the connection ID
      Throws:
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnector.connect`

    - #### close

          public void close()
                     throws IOException

      Description copied from interface: `RMIConnection`

      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:
        `close` in interface `Closeable`
      Specified by:
        `close` in interface `AutoCloseable`
      Specified by:
        `close` in interface `RMIConnection`
      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.

    - #### unreferenced

          public void unreferenced()

      Description copied from interface: `Unreferenced`
      Called by the RMI runtime sometime after the runtime determines that the reference list, the list of clients referencing the remote object, becomes empty.
      Specified by:
        `unreferenced` in interface `Unreferenced`

    - #### createMBean

          public ObjectInstance createMBean(String className,
                                            ObjectName name,
                                            Subject delegationSubject)
                                     throws ReflectionException,
                                            InstanceAlreadyExistsException,
                                            MBeanRegistrationException,
                                            MBeanException,
                                            NotCompliantMBeanException,
                                            IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.createMBean(String, ObjectName)`.
      Specified by:
        `createMBean` in interface `RMIConnection`
      Parameters:
        `className` - The class name of the MBean to be instantiated.
        `name` - The object name of the MBean. May be null.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        An `ObjectInstance`, containing the `ObjectName` and the Java class name of the newly instantiated MBean. If the contained `ObjectName` is `n`, the contained Java class name is ``getMBeanInfo(n)`.getClassName()`.
      Throws:
        `ReflectionException` - Wraps a `java.lang.ClassNotFoundException` or a `java.lang.Exception` that occurred when trying to invoke the MBean's constructor.
        `InstanceAlreadyExistsException` - The MBean is already under the control of the MBean server.
        `MBeanRegistrationException` - The `preRegister` (`MBeanRegistration` interface) method of the MBean has thrown an exception. The MBean will not be registered.
        `MBeanException` - The constructor of the MBean has thrown an exception.
        `NotCompliantMBeanException` - This class is not a JMX compliant MBean.
        `IOException` - if a general communication exception occurred.

    - #### createMBean

          public ObjectInstance createMBean(String className,
                                            ObjectName name,
                                            ObjectName loaderName,
                                            Subject delegationSubject)
                                     throws ReflectionException,
                                            InstanceAlreadyExistsException,
                                            MBeanRegistrationException,
                                            MBeanException,
                                            NotCompliantMBeanException,
                                            InstanceNotFoundException,
                                            IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.createMBean(String, ObjectName, ObjectName)`.
      Specified by:
        `createMBean` in interface `RMIConnection`
      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` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        An `ObjectInstance`, containing the `ObjectName` and the Java class name of the newly instantiated MBean. If the contained `ObjectName` is `n`, the contained Java class name is ``getMBeanInfo(n)`.getClassName()`.
      Throws:
        `ReflectionException` - Wraps a `java.lang.ClassNotFoundException` or a `java.lang.Exception` that occurred when trying to invoke the MBean's constructor.
        `InstanceAlreadyExistsException` - The MBean is already under the control of the MBean server.
        `MBeanRegistrationException` - The `preRegister` (`MBeanRegistration` interface) method of the MBean has thrown an exception. The MBean will not be registered.
        `MBeanException` - The constructor of the MBean has thrown an exception.
        `NotCompliantMBeanException` - This class is not a JMX compliant MBean.
        `InstanceNotFoundException` - The specified class loader is not registered in the MBean server.
        `IOException` - if a general communication exception occurred.

    - #### createMBean

          public ObjectInstance createMBean(String className,
                                            ObjectName name,
                                            MarshalledObject params,
                                            String[] signature,
                                            Subject delegationSubject)
                                     throws ReflectionException,
                                            InstanceAlreadyExistsException,
                                            MBeanRegistrationException,
                                            MBeanException,
                                            NotCompliantMBeanException,
                                            IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.createMBean(String, ObjectName, Object[], String[])`. The `Object[]` parameter is wrapped in a `MarshalledObject`.
      Specified by:
        `createMBean` in interface `RMIConnection`
      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 a `MarshalledObject`. 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` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        An `ObjectInstance`, containing the `ObjectName` and the Java class name of the newly instantiated MBean. If the contained `ObjectName` is `n`, the contained Java class name is ``getMBeanInfo(n)`.getClassName()`.
      Throws:
        `ReflectionException` - Wraps a `java.lang.ClassNotFoundException` or a `java.lang.Exception` that occurred when trying to invoke the MBean's constructor.
        `InstanceAlreadyExistsException` - The MBean is already under the control of the MBean server.
        `MBeanRegistrationException` - The `preRegister` (`MBeanRegistration` interface) method of the MBean has thrown an exception. The MBean will not be registered.
        `MBeanException` - The constructor of the MBean has thrown an exception.
        `NotCompliantMBeanException` - This class is not a JMX compliant MBean.
        `IOException` - if a general communication exception occurred.

    - #### createMBean

          public ObjectInstance createMBean(String className,
                                            ObjectName name,
                                            ObjectName loaderName,
                                            MarshalledObject params,
                                            String[] signature,
                                            Subject delegationSubject)
                                     throws ReflectionException,
                                            InstanceAlreadyExistsException,
                                            MBeanRegistrationException,
                                            MBeanException,
                                            NotCompliantMBeanException,
                                            InstanceNotFoundException,
                                            IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.createMBean(String, ObjectName, ObjectName, Object[], String[])`. The `Object[]` parameter is wrapped in a `MarshalledObject`.
      Specified by:
        `createMBean` in interface `RMIConnection`
      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 a `MarshalledObject`. 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` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        An `ObjectInstance`, containing the `ObjectName` and the Java class name of the newly instantiated MBean. If the contained `ObjectName` is `n`, the contained Java class name is ``getMBeanInfo(n)`.getClassName()`.
      Throws:
        `ReflectionException` - Wraps a `java.lang.ClassNotFoundException` or a `java.lang.Exception` that occurred when trying to invoke the MBean's constructor.
        `InstanceAlreadyExistsException` - The MBean is already under the control of the MBean server.
        `MBeanRegistrationException` - The `preRegister` (`MBeanRegistration` interface) method of the MBean has thrown an exception. The MBean will not be registered.
        `MBeanException` - The constructor of the MBean has thrown an exception.
        `NotCompliantMBeanException` - This class is not a JMX compliant MBean.
        `InstanceNotFoundException` - The specified class loader is not registered in the MBean server.
        `IOException` - if a general communication exception occurred.

    - #### unregisterMBean

          public void unregisterMBean(ObjectName name,
                                      Subject delegationSubject)
                               throws InstanceNotFoundException,
                                      MBeanRegistrationException,
                                      IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.unregisterMBean(ObjectName)`.
      Specified by:
        `unregisterMBean` in interface `RMIConnection`
      Parameters:
        `name` - The object name of the MBean to be unregistered.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Throws:
        `InstanceNotFoundException` - The MBean specified is not registered in the MBean server.
        `MBeanRegistrationException` - The preDeregister ((`MBeanRegistration` interface) method of the MBean has thrown an exception.
        `IOException` - if a general communication exception occurred.

    - #### getObjectInstance

          public ObjectInstance getObjectInstance(ObjectName name,
                                                  Subject delegationSubject)
                                           throws InstanceNotFoundException,
                                                  IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getObjectInstance(ObjectName)`.
      Specified by:
        `getObjectInstance` in interface `RMIConnection`
      Parameters:
        `name` - The object name of the MBean.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        The `ObjectInstance` associated with the MBean specified by name. The contained `ObjectName` is `name` and the contained class name is ``getMBeanInfo(name)`.getClassName()`.
      Throws:
        `InstanceNotFoundException` - The MBean specified is not registered in the MBean server.
        `IOException` - if a general communication exception occurred.

    - #### queryMBeans

          public Set<ObjectInstance> queryMBeans(ObjectName name,
                                                 MarshalledObject query,
                                                 Subject delegationSubject)
                                          throws IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.queryMBeans(ObjectName, QueryExp)`. The `QueryExp` is wrapped in a `MarshalledObject`.
      Specified by:
        `queryMBeans` in interface `RMIConnection`
      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 a `MarshalledObject`. If the `MarshalledObject` encapsulates a null value no query expression will be applied for selecting MBeans.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        A set containing the `ObjectInstance` objects for the selected MBeans. If no MBean satisfies the query an empty list is returned.
      Throws:
        `IOException` - if a general communication exception occurred.

    - #### queryNames

          public Set<ObjectName> queryNames(ObjectName name,
                                            MarshalledObject query,
                                            Subject delegationSubject)
                                     throws IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.queryNames(ObjectName, QueryExp)`. The `QueryExp` is wrapped in a `MarshalledObject`.
      Specified by:
        `queryNames` in interface `RMIConnection`
      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 a `MarshalledObject`. If the `MarshalledObject` encapsulates a null value no query expression will be applied for selecting MBeans.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.
      Throws:
        `IOException` - if a general communication exception occurred.

    - #### isRegistered

          public boolean isRegistered(ObjectName name,
                                      Subject delegationSubject)
                               throws IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.isRegistered(ObjectName)`.
      Specified by:
        `isRegistered` in interface `RMIConnection`
      Parameters:
        `name` - The object name of the MBean to be checked.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        True if the MBean is already registered in the MBean server, false otherwise.
      Throws:
        `IOException` - if a general communication exception occurred.

    - #### getMBeanCount

          public Integer getMBeanCount(Subject delegationSubject)
                                throws IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getMBeanCount()`.
      Specified by:
        `getMBeanCount` in interface `RMIConnection`
      Parameters:
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        the number of MBeans registered.
      Throws:
        `IOException` - if a general communication exception occurred.

    - #### getAttribute

          public Object getAttribute(ObjectName name,
                                     String attribute,
                                     Subject delegationSubject)
                              throws MBeanException,
                                     AttributeNotFoundException,
                                     InstanceNotFoundException,
                                     ReflectionException,
                                     IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getAttribute(ObjectName, String)`.
      Specified by:
        `getAttribute` in interface `RMIConnection`
      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` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        The value of the retrieved attribute.
      Throws:
        `MBeanException` - Wraps an exception thrown by the MBean's getter.
        `AttributeNotFoundException` - The attribute specified is not accessible in the MBean.
        `InstanceNotFoundException` - The MBean specified is not registered in the MBean server.
        `ReflectionException` - Wraps a `java.lang.Exception` thrown when trying to invoke the getter.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.setAttribute(javax.management.ObjectName, java.rmi.MarshalledObject, javax.security.auth.Subject)`

    - #### getAttributes

          public AttributeList getAttributes(ObjectName name,
                                             String[] attributes,
                                             Subject delegationSubject)
                                      throws InstanceNotFoundException,
                                             ReflectionException,
                                             IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getAttributes(ObjectName, String[])`.
      Specified by:
        `getAttributes` in interface `RMIConnection`
      Parameters:
        `name` - The object name of the MBean from which the attributes are retrieved.
        `attributes` - A list of the attributes to be retrieved.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      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.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.setAttributes(javax.management.ObjectName, java.rmi.MarshalledObject, javax.security.auth.Subject)`

    - #### setAttribute

          public void setAttribute(ObjectName name,
                                   MarshalledObject attribute,
                                   Subject delegationSubject)
                            throws InstanceNotFoundException,
                                   AttributeNotFoundException,
                                   InvalidAttributeValueException,
                                   MBeanException,
                                   ReflectionException,
                                   IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.setAttribute(ObjectName, Attribute)`. The `Attribute` parameter is wrapped in a `MarshalledObject`.
      Specified by:
        `setAttribute` in interface `RMIConnection`
      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 a `MarshalledObject`.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      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 a `java.lang.Exception` thrown when trying to invoke the setter.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.getAttribute(javax.management.ObjectName, java.lang.String, javax.security.auth.Subject)`

    - #### setAttributes

          public AttributeList setAttributes(ObjectName name,
                                             MarshalledObject attributes,
                                             Subject delegationSubject)
                                      throws InstanceNotFoundException,
                                             ReflectionException,
                                             IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.setAttributes(ObjectName, AttributeList)`. The `AttributeList` parameter is wrapped in a `MarshalledObject`.
      Specified by:
        `setAttributes` in interface `RMIConnection`
      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 a `MarshalledObject`.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      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.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.getAttributes(javax.management.ObjectName, java.lang.String[], javax.security.auth.Subject)`

    - #### invoke

          public Object invoke(ObjectName name,
                               String operationName,
                               MarshalledObject params,
                               String[] signature,
                               Subject delegationSubject)
                        throws InstanceNotFoundException,
                               MBeanException,
                               ReflectionException,
                               IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.invoke(ObjectName, String, Object[], String[])`. The `Object[]` parameter is wrapped in a `MarshalledObject`.
      Specified by:
        `invoke` in interface `RMIConnection`
      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 a `MarshalledObject`. 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` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      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 a `java.lang.Exception` thrown while trying to invoke the method.
        `IOException` - if a general communication exception occurred.

    - #### getDefaultDomain

          public String getDefaultDomain(Subject delegationSubject)
                                  throws IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getDefaultDomain()`.
      Specified by:
        `getDefaultDomain` in interface `RMIConnection`
      Parameters:
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        the default domain.
      Throws:
        `IOException` - if a general communication exception occurred.

    - #### getDomains

          public String[] getDomains(Subject delegationSubject)
                              throws IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getDomains()`.
      Specified by:
        `getDomains` in interface `RMIConnection`
      Parameters:
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        the list of domains.
      Throws:
        `IOException` - if a general communication exception occurred.

    - #### getMBeanInfo

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

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.getMBeanInfo(ObjectName)`.
      Specified by:
        `getMBeanInfo` in interface `RMIConnection`
      Parameters:
        `name` - The name of the MBean to analyze
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Returns:
        An instance of `MBeanInfo` allowing the retrieval of all attributes and operations of this MBean.
      Throws:
        `InstanceNotFoundException` - The MBean specified was not found.
        `IntrospectionException` - An exception occurred during introspection.
        `ReflectionException` - An exception occurred when trying to invoke the getMBeanInfo of a Dynamic MBean.
        `IOException` - if a general communication exception occurred.

    - #### isInstanceOf

          public boolean isInstanceOf(ObjectName name,
                                      String className,
                                      Subject delegationSubject)
                               throws InstanceNotFoundException,
                                      IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.isInstanceOf(ObjectName, String)`.
      Specified by:
        `isInstanceOf` in interface `RMIConnection`
      Parameters:
        `name` - The `ObjectName` of the MBean.
        `className` - The name of the class.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      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.
        `IOException` - if a general communication exception occurred.

    - #### addNotificationListeners

          public Integer[] addNotificationListeners(ObjectName[] names,
                                                    MarshalledObject[] filters,
                                                    Subject[] delegationSubjects)
                                             throws InstanceNotFoundException,
                                                    IOException

      Description copied from interface: `RMIConnection`

      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 `fetchNotifications` method.

      For each listener, the original `NotificationListener` and `handback` are kept on the client side; in order for the client to be able to identify them, the server generates and returns a unique `listenerID`. This `listenerID` is forwarded with the `Notifications` to 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.

      Specified by:
        `addNotificationListeners` in interface `RMIConnection`
      Parameters:
        `names` - the `ObjectNames` identifying the MBeans emitting the Notifications.
        `filters` - an array of marshalled representations of the `NotificationFilters`. Elements of this array can be null.
        `delegationSubjects` - the `Subjects` on behalf of which the listeners are being added. Elements of this array can be null. Also, the `delegationSubjects` parameter itself can be null, which is equivalent to an array of null values with the same size as the `names` and `filters` arrays.
      Returns:
        an array of `listenerIDs` identifying the local listeners. This array has the same number of elements as the parameters.
      Throws:
        `InstanceNotFoundException` - if one of the `names` does not correspond to any registered MBean.
        `IOException` - if a general communication exception occurred.

    - #### addNotificationListener

          public void addNotificationListener(ObjectName name,
                                              ObjectName listener,
                                              MarshalledObject filter,
                                              MarshalledObject handback,
                                              Subject delegationSubject)
                                       throws InstanceNotFoundException,
                                              IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)`. The `NotificationFilter` parameter is wrapped in a `MarshalledObject`. The `Object` (handback) parameter is also wrapped in a `MarshalledObject`.
      Specified by:
        `addNotificationListener` in interface `RMIConnection`
      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 a `MarshalledObject`. If filter encapsulated in the `MarshalledObject` has 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 a `MarshalledObject`.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Throws:
        `InstanceNotFoundException` - The MBean name of the notification listener or of the notification broadcaster does not match any of the registered MBeans.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.removeNotificationListener(ObjectName, ObjectName, Subject)`, `RMIConnection.removeNotificationListener(ObjectName, ObjectName, MarshalledObject, MarshalledObject, Subject)`

    - #### removeNotificationListeners

          public void removeNotificationListeners(ObjectName name,
                                                  Integer[] listenerIDs,
                                                  Subject delegationSubject)
                                           throws InstanceNotFoundException,
                                                  ListenerNotFoundException,
                                                  IOException

      Description copied from interface: `RMIConnection`

      Handles the `removeNotificationListener(ObjectName, NotificationListener)` and `removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)` methods.

      This method removes one or more `NotificationListener`s from a given MBean in the MBean server.

      The `NotificationListeners` are identified by the IDs which were returned by the `RMIConnection.addNotificationListeners(ObjectName[], MarshalledObject[], Subject[])` method.

      Specified by:
        `removeNotificationListeners` in interface `RMIConnection`
      Parameters:
        `name` - the `ObjectName` identifying the MBean emitting the Notifications.
        `listenerIDs` - the list of the IDs corresponding to the listeners to remove.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Throws:
        `InstanceNotFoundException` - if the given `name` does 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 to `MBeanServer.removeNotificationListener`.
        `IOException` - if a general communication exception occurred.

    - #### removeNotificationListener

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

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName)`.
      Specified by:
        `removeNotificationListener` in interface `RMIConnection`
      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` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      Throws:
        `InstanceNotFoundException` - The MBean name provided does not match any of the registered MBeans.
        `ListenerNotFoundException` - The listener is not registered in the MBean.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.addNotificationListener(javax.management.ObjectName, javax.management.ObjectName, java.rmi.MarshalledObject, java.rmi.MarshalledObject, javax.security.auth.Subject)`

    - #### removeNotificationListener

          public void removeNotificationListener(ObjectName name,
                                                 ObjectName listener,
                                                 MarshalledObject filter,
                                                 MarshalledObject handback,
                                                 Subject delegationSubject)
                                          throws InstanceNotFoundException,
                                                 ListenerNotFoundException,
                                                 IOException

      Description copied from interface: `RMIConnection`
      Handles the method `MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)`. The `NotificationFilter` parameter is wrapped in a `MarshalledObject`. The `Object` parameter is also wrapped in a `MarshalledObject`.
      Specified by:
        `removeNotificationListener` in interface `RMIConnection`
      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 a `MarshalledObject`.
        `handback` - The handback that was specified when the listener was added, encapsulated into a `MarshalledObject`.
        `delegationSubject` - The `Subject` containing the delegation principals or `null` if the authentication principal is used instead.
      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.
        `IOException` - if a general communication exception occurred.
      See Also:
        `RMIConnection.addNotificationListener(javax.management.ObjectName, javax.management.ObjectName, java.rmi.MarshalledObject, java.rmi.MarshalledObject, javax.security.auth.Subject)`

    - #### fetchNotifications

          public NotificationResult fetchNotifications(long clientSequenceNumber,
                                                       int maxNotifications,
                                                       long timeout)
                                                throws IOException

      Description copied from interface: `RMIConnection`

      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 `clientSequenceNumber` and 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 by `RMIConnection.addNotificationListeners(ObjectName[], MarshalledObject[], Subject[])`.

      Specified by:
        `fetchNotifications` in interface `RMIConnection`
      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. The `TargetedNotification` array in the returned `NotificationResult` can 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 be `Long.MAX_VALUE` to 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.

    - #### toString

          public String toString()

      Returns a string representation of this object. In general, the `toString` method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read.

      Overrides:
        `toString` in class `Object`
      Returns:
        a String representation of this object.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2016, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.