RMIConnectorServer (Java Platform SE 8 )
Keywords: javax.management.remote.rmi.RMIConnectorServer class
Date: 2016-04-24

compact3
javax.management.remote.rmi

## Class RMIConnectorServer

- java.lang.Object
- - javax.management.NotificationBroadcasterSupport
  - - javax.management.remote.JMXConnectorServer
    - - javax.management.remote.rmi.RMIConnectorServer

- All Implemented Interfaces:
    MBeanRegistration, NotificationBroadcaster, NotificationEmitter, JMXAddressable, JMXConnectorServerMBean

      public class RMIConnectorServer
      extends JMXConnectorServer

  A JMX API connector server that creates RMI-based connections from remote clients. Usually, such connector servers are made using `JMXConnectorServerFactory`. However, specialized applications can use this class directly, for example with an `RMIServerImpl` object.

  Since:
    1.5

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `JNDI_REBIND_ATTRIBUTE` Name of the attribute that specifies whether the `RMIServer` stub that represents an RMI connector server should override an existing stub at the same address.
    `static String` | `RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE` Name of the attribute that specifies the `RMIClientSocketFactory` for the RMI objects created in conjunction with this connector.
    `static String` | `RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE` Name of the attribute that specifies the `RMIServerSocketFactory` for the RMI objects created in conjunction with this connector.

    - ### Fields inherited from class javax.management.remote.JMXConnectorServer

      `AUTHENTICATOR`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `RMIConnectorServer(JMXServiceURL url, Map<String,?> environment)` Makes an `RMIConnectorServer`.
    `RMIConnectorServer(JMXServiceURL url, Map<String,?> environment, MBeanServer mbeanServer)` Makes an `RMIConnectorServer` for the given MBean server.
    `RMIConnectorServer(JMXServiceURL url, Map<String,?> environment, RMIServerImpl rmiServerImpl, MBeanServer mbeanServer)` Makes an `RMIConnectorServer` for the given MBean server.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `connectionClosed(String connectionId, String message, Object userData)` Called by a subclass when a client connection is closed normally.
    `protected void` | `connectionFailed(String connectionId, String message, Object userData)` Called by a subclass when a client connection fails.
    `protected void` | `connectionOpened(String connectionId, String message, Object userData)` Called by a subclass when a new client connection is opened.
    `JMXServiceURL` | `getAddress()` The address of this connector server.
    `Map<String,?>` | `getAttributes()` The attributes for this connector server.
    `boolean` | `isActive()` Determines whether the connector server is active.
    `void` | `setMBeanServerForwarder(MBeanServerForwarder mbsf)` Inserts an object that intercepts requests for the MBean server that arrive through this connector server.
    `void` | `start()` Activates the connector server, that is starts listening for client connections.
    `void` | `stop()` Deactivates the connector server, that is, stops listening for client connections.
    `JMXConnector` | `toJMXConnector(Map<String,?> env)` Returns a client stub for this connector server.

    - ### Methods inherited from class javax.management.remote.JMXConnectorServer

      `getConnectionIds, getMBeanServer, getNotificationInfo, postDeregister, postRegister, preDeregister, preRegister`

    - ### Methods inherited from class javax.management.NotificationBroadcasterSupport

      `addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification`

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

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

- - ### Field Detail

    - #### JNDI_REBIND_ATTRIBUTE

          public static final String JNDI_REBIND_ATTRIBUTE

      Name of the attribute that specifies whether the `RMIServer` stub that represents an RMI connector server should override an existing stub at the same address. The value associated with this attribute, if any, should be a string that is equal, ignoring case, to `"true"` or `"false"`. The default value is false.

      See Also:
        Constant Field Values

    - #### RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE

          public static final String RMI_CLIENT_SOCKET_FACTORY_ATTRIBUTE

      Name of the attribute that specifies the `RMIClientSocketFactory` for the RMI objects created in conjunction with this connector. The value associated with this attribute must be of type `RMIClientSocketFactory` and can only be specified in the `Map` argument supplied when creating a connector server.

      See Also:
        Constant Field Values

    - #### RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE

          public static final String RMI_SERVER_SOCKET_FACTORY_ATTRIBUTE

      Name of the attribute that specifies the `RMIServerSocketFactory` for the RMI objects created in conjunction with this connector. The value associated with this attribute must be of type `RMIServerSocketFactory` and can only be specified in the `Map` argument supplied when creating a connector server.

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### RMIConnectorServer

          public RMIConnectorServer(JMXServiceURL url,
                                    Map<String,?> environment)
                             throws IOException

      Makes an `RMIConnectorServer`. This is equivalent to calling `RMIConnectorServer(directoryURL,environment,null,null)`

      Parameters:
        `url` - the URL defining how to create the connector server. Cannot be null.
        `environment` - attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.
      Throws:
        `IllegalArgumentException` - if `url` is null.
        `MalformedURLException` - if `url` does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are valid when this constructor is used.
        `IOException` - if the connector server cannot be created for some reason or if it is inevitable that its `start` method will fail.

    - #### RMIConnectorServer

          public RMIConnectorServer(JMXServiceURL url,
                                    Map<String,?> environment,
                                    MBeanServer mbeanServer)
                             throws IOException

      Makes an `RMIConnectorServer` for the given MBean server. This is equivalent to calling `RMIConnectorServer(directoryURL,environment,null,mbeanServer)`

      Parameters:
        `url` - the URL defining how to create the connector server. Cannot be null.
        `environment` - attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.
        `mbeanServer` - the MBean server to which the new connector server is attached, or null if it will be attached by being registered as an MBean in the MBean server.
      Throws:
        `IllegalArgumentException` - if `url` is null.
        `MalformedURLException` - if `url` does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are valid when this constructor is used.
        `IOException` - if the connector server cannot be created for some reason or if it is inevitable that its `start` method will fail.

    - #### RMIConnectorServer

          public RMIConnectorServer(JMXServiceURL url,
                                    Map<String,?> environment,
                                    RMIServerImpl rmiServerImpl,
                                    MBeanServer mbeanServer)
                             throws IOException

      Makes an `RMIConnectorServer` for the given MBean server.

      Parameters:
        `url` - the URL defining how to create the connector server. Cannot be null.
        `environment` - attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.
        `rmiServerImpl` - An implementation of the RMIServer interface, consistent with the protocol type specified in url. If this parameter is non null, the protocol type specified by url is not constrained, and is assumed to be valid. Otherwise, only "rmi" and "iiop" will be recognized.
        `mbeanServer` - the MBean server to which the new connector server is attached, or null if it will be attached by being registered as an MBean in the MBean server.
      Throws:
        `IllegalArgumentException` - if `url` is null.
        `MalformedURLException` - if `url` does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are recognized when rmiServerImpl is null.
        `IOException` - if the connector server cannot be created for some reason or if it is inevitable that its `start` method will fail.
      See Also:
        `start()`

  - ### Method Detail

    - #### toJMXConnector

          public JMXConnector toJMXConnector(Map<String,?> env)
                                      throws IOException

      Returns a client stub for this connector server. A client stub is a serializable object whose `connect` method can be used to make one new connection to this connector server.

      Specified by:
        `toJMXConnector` in interface `JMXConnectorServerMBean`
      Overrides:
        `toJMXConnector` in class `JMXConnectorServer`
      Parameters:
        `env` - client connection parameters of the same sort that could be provided to `JMXConnector.connect(Map)`. Can be null, which is equivalent to an empty map.
      Returns:
        a client stub that can be used to make a new connection to this connector server.
      Throws:
        `UnsupportedOperationException` - if this connector server does not support the generation of client stubs.
        `IllegalStateException` - if the JMXConnectorServer is not started (see `isActive()`).
        `IOException` - if a communications problem means that a stub cannot be created.

    - #### start

          public void start()
                     throws IOException

      Activates the connector server, that is starts listening for client connections. Calling this method when the connector server is already active has no effect. Calling this method when the connector server has been stopped will generate an `IOException`.

      The behavior of this method when called for the first time depends on the parameters that were supplied at construction, as described below.

      First, an object of a subclass of `RMIServerImpl` is required, to export the connector server through RMI:

      - If an `RMIServerImpl` was supplied to the constructor, it is used.
      - Otherwise, if the protocol part of the `JMXServiceURL` supplied to the constructor was `iiop`, an object of type `RMIIIOPServerImpl` is created.
      - Otherwise, if the `JMXServiceURL` was null, or its protocol part was `rmi`, an object of type `RMIJRMPServerImpl` is created.
      - Otherwise, the implementation can create an implementation-specific `RMIServerImpl` or it can throw `MalformedURLException`.

      If the given address includes a JNDI directory URL as specified in the package documentation for `javax.management.remote.rmi`, then this `RMIConnectorServer` will bootstrap by binding the `RMIServerImpl` to the given address.

      If the URL path part of the `JMXServiceURL` was empty or a single slash (`/`), then the RMI object will not be bound to a directory. Instead, a reference to it will be encoded in the URL path of the RMIConnectorServer address (returned by `getAddress()`). The encodings for `rmi` and `iiop` are described in the package documentation for `javax.management.remote.rmi`.

      The behavior when the URL path is neither empty nor a JNDI directory URL, or when the protocol is neither `rmi` nor `iiop`, is implementation defined, and may include throwing `MalformedURLException` when the connector server is created or when it is started.

      Throws:
        `IllegalStateException` - if the connector server has not been attached to an MBean server.
        `IOException` - if the connector server cannot be started, or in the case of the `iiop` protocol, that RMI/IIOP is not supported.

    - #### stop

          public void stop()
                    throws IOException

      Deactivates the connector server, that is, stops listening for client connections. Calling this method will also close all client connections that were made by this server. After this method returns, whether normally or with an exception, the connector server will not create any new client connections.

      Once a connector server has been stopped, it cannot be started again.

      Calling this method when the connector server has already been stopped has no effect. Calling this method when the connector server has not yet been started will disable the connector server object permanently.

      If closing a client connection produces an exception, that exception is not thrown from this method. A `JMXConnectionNotification` is emitted from this MBean with the connection ID of the connection that could not be closed.

      Closing a connector server is a potentially slow operation. For example, if a client machine with an open connection has crashed, the close operation might have to wait for a network protocol timeout. Callers that do not want to block in a close operation should do it in a separate thread.

      This method calls the method `close` on the connector server's `RMIServerImpl` object.

      If the `RMIServerImpl` was bound to a JNDI directory by the `start` method, it is unbound from the directory by this method.

      Throws:
        `IOException` - if the server cannot be closed cleanly, or if the `RMIServerImpl` cannot be unbound from the directory. When this exception is thrown, the server has already attempted to close all client connections, if appropriate; to call `RMIServerImpl.close()`; and to unbind the `RMIServerImpl` from its directory, if appropriate. All client connections are closed except possibly those that generated exceptions when the server attempted to close them.

    - #### isActive

          public boolean isActive()

      Description copied from interface: `JMXConnectorServerMBean`

      Determines whether the connector server is active. A connector server starts being active when its `start` method returns successfully and remains active until either its `stop` method is called or the connector server fails.

      Returns:
        true if the connector server is active.

    - #### getAddress

          public JMXServiceURL getAddress()

      Description copied from interface: `JMXConnectorServerMBean`

      The address of this connector server.

      The address returned may not be the exact original `JMXServiceURL` that was supplied when creating the connector server, since the original address may not always be complete. For example the port number may be dynamically allocated when starting the connector server. Instead the address returned is the actual `JMXServiceURL` of the `JMXConnectorServer`. This is the address that clients supply to `JMXConnectorFactory.connect(JMXServiceURL)`.

      Note that the address returned may be `null` if the `JMXConnectorServer` is not yet `active`.

      Returns:
        the address of this connector server, or null if it does not have one.

    - #### getAttributes

          public Map<String,?> getAttributes()

      Description copied from interface: `JMXConnectorServerMBean`

      The attributes for this connector server.

      Returns:
        a read-only map containing the attributes for this connector server. Attributes whose values are not serializable are omitted from this map. If there are no serializable attributes, the returned map is empty.

    - #### setMBeanServerForwarder

          public void setMBeanServerForwarder(MBeanServerForwarder mbsf)

      Description copied from interface: `JMXConnectorServerMBean`

      Inserts an object that intercepts requests for the MBean server that arrive through this connector server. This object will be supplied as the `MBeanServer` for any new connection created by this connector server. Existing connections are unaffected.

      This method can be called more than once with different `MBeanServerForwarder` objects. The result is a chain of forwarders. The last forwarder added is the first in the chain. In more detail:

      - If this connector server is already associated with an `MBeanServer` object, then that object is given to `mbsf.setMBeanServer`. If doing so produces an exception, this method throws the same exception without any other effect.

      - If this connector is not already associated with an `MBeanServer` object, or if the `mbsf.setMBeanServer` call just mentioned succeeds, then `mbsf` becomes this connector server's `MBeanServer`.

      Specified by:
        `setMBeanServerForwarder` in interface `JMXConnectorServerMBean`
      Overrides:
        `setMBeanServerForwarder` in class `JMXConnectorServer`
      Parameters:
        `mbsf` - the new `MBeanServerForwarder`.

    - #### connectionOpened

          protected void connectionOpened(String connectionId,
                                          String message,
                                          Object userData)

      Description copied from class: `JMXConnectorServer`

      Called by a subclass when a new client connection is opened. Adds `connectionId` to the list returned by `JMXConnectorServer.getConnectionIds()`, then emits a `JMXConnectionNotification` with type `JMXConnectionNotification.OPENED`.

      Overrides:
        `connectionOpened` in class `JMXConnectorServer`
      Parameters:
        `connectionId` - the ID of the new connection. This must be different from the ID of any connection previously opened by this connector server.
        `message` - the message for the emitted `JMXConnectionNotification`. Can be null. See `Notification.getMessage()`.
        `userData` - the `userData` for the emitted `JMXConnectionNotification`. Can be null. See `Notification.getUserData()`.

    - #### connectionClosed

          protected void connectionClosed(String connectionId,
                                          String message,
                                          Object userData)

      Description copied from class: `JMXConnectorServer`

      Called by a subclass when a client connection is closed normally. Removes `connectionId` from the list returned by `JMXConnectorServer.getConnectionIds()`, then emits a `JMXConnectionNotification` with type `JMXConnectionNotification.CLOSED`.

      Overrides:
        `connectionClosed` in class `JMXConnectorServer`
      Parameters:
        `connectionId` - the ID of the closed connection.
        `message` - the message for the emitted `JMXConnectionNotification`. Can be null. See `Notification.getMessage()`.
        `userData` - the `userData` for the emitted `JMXConnectionNotification`. Can be null. See `Notification.getUserData()`.

    - #### connectionFailed

          protected void connectionFailed(String connectionId,
                                          String message,
                                          Object userData)

      Description copied from class: `JMXConnectorServer`

      Called by a subclass when a client connection fails. Removes `connectionId` from the list returned by `JMXConnectorServer.getConnectionIds()`, then emits a `JMXConnectionNotification` with type `JMXConnectionNotification.FAILED`.

      Overrides:
        `connectionFailed` in class `JMXConnectorServer`
      Parameters:
        `connectionId` - the ID of the failed connection.
        `message` - the message for the emitted `JMXConnectionNotification`. Can be null. See `Notification.getMessage()`.
        `userData` - the `userData` for the emitted `JMXConnectionNotification`. Can be null. See `Notification.getUserData()`.

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.