Class ConnectorServer

  • All Implemented Interfaces:
    LifeCycle

    public class ConnectorServer
    extends AbstractLifeCycle

    LifeCycle wrapper for JMXConnectorServer.

    This class provides the following facilities:

    • participates in the Server lifecycle
    • starts the RMI registry if not there already
    • allows to bind the RMI registry and the RMI server to the loopback interface
    • makes it easy to use TLS for the RMI communication
    • Field Detail

      • RMI_REGISTRY_CLIENT_SOCKET_FACTORY_ATTRIBUTE

        public static final java.lang.String RMI_REGISTRY_CLIENT_SOCKET_FACTORY_ATTRIBUTE
        See Also:
        Constant Field Values
    • Constructor Detail

      • ConnectorServer

        public ConnectorServer​(javax.management.remote.JMXServiceURL serviceURL,
                               java.lang.String objectName)
        Constructs a ConnectorServer
        Parameters:
        serviceURL - the address of the new ConnectorServer
        objectName - object name string to be assigned to ConnectorServer bean
      • ConnectorServer

        public ConnectorServer​(javax.management.remote.JMXServiceURL serviceURL,
                               java.util.Map<java.lang.String,​?> environment,
                               java.lang.String objectName)
        Constructs a ConnectorServer
        Parameters:
        serviceURL - the address of the new ConnectorServer
        environment - a set of attributes to control the new ConnectorServer's behavior. This parameter can be null. Keys in this map must be Strings. The appropriate type of each associated value depends on the attribute. The contents of environment are not changed by this call.
        objectName - object name string to be assigned to ConnectorServer bean
      • ConnectorServer

        public ConnectorServer​(javax.management.remote.JMXServiceURL serviceURL,
                               java.util.Map<java.lang.String,​?> environment,
                               java.lang.String objectName,
                               SslContextFactory.Server sslContextFactory)
        Constructs a ConnectorServer
        Parameters:
        serviceURL - the address of the new ConnectorServer
        environment - a set of attributes to control the new ConnectorServer's behavior. This parameter can be null. Keys in this map must be Strings. The appropriate type of each associated value depends on the attribute. The contents of environment are not changed by this call.
        objectName - object name string to be assigned to ConnectorServer bean
        sslContextFactory - the SslContextFactory.Server to use for secure communication
    • Method Detail

      • getAddress

        public javax.management.remote.JMXServiceURL getAddress()
        Returns:
        the JMXServiceURL of this ConnectorServer
      • putAttribute

        public void putAttribute​(java.lang.String name,
                                 java.lang.Object value)
        Puts an attribute into the environment Map.
        Parameters:
        name - the attribute name
        value - the attribute value
      • getObjectName

        public java.lang.String getObjectName()
        Returns:
        the ObjectName of this ConnectorServer
      • setObjectName

        public void setObjectName​(java.lang.String objectName)
        Parameters:
        objectName - the ObjectName of this ConnectorServer
      • doStart

        public void doStart()
                     throws java.lang.Exception
        Description copied from class: AbstractLifeCycle
        Method to override to start the lifecycle
        Overrides:
        doStart in class AbstractLifeCycle
        Throws:
        AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.
        java.lang.Exception - If there was a problem starting. Will cause a transition to FAILED state
      • doStop

        public void doStop()
                    throws java.lang.Exception
        Description copied from class: AbstractLifeCycle
        Method to override to stop the lifecycle
        Overrides:
        doStop in class AbstractLifeCycle
        Throws:
        java.lang.Exception - If there was a problem stopping. Will cause a transition to FAILED state