Interface JmxConnectionHandlerCfg

  • All Superinterfaces:
    Configuration, ConnectionHandlerCfg

    public interface JmxConnectionHandlerCfg
    extends ConnectionHandlerCfg
    A server-side interface for querying JMX Connection Handler settings.

    The JMX Connection Handler is used to interact with clients using the Java Management Extensions (JMX) protocol.

    • Method Detail

      • addJmxChangeListener

        void addJmxChangeListener​(ConfigurationChangeListener<JmxConnectionHandlerCfg> listener)
        Register to be notified when this JMX Connection Handler is changed.
        Parameters:
        listener - The JMX Connection Handler configuration change listener.
      • removeJmxChangeListener

        void removeJmxChangeListener​(ConfigurationChangeListener<JmxConnectionHandlerCfg> listener)
        Deregister an existing JMX Connection Handler configuration change listener.
        Parameters:
        listener - The JMX Connection Handler configuration change listener.
      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation.

        Default value: org.opends.server.protocols.jmx.JmxConnectionHandler

        Specified by:
        getJavaClass in interface ConnectionHandlerCfg
        Returns:
        Returns the value of the "java-class" property.
      • getKeyManagerProvider

        String getKeyManagerProvider()
        Gets the "key-manager-provider" property.

        Specifies the name of the key manager that should be used with this JMX Connection Handler .

        Default value is undefined

        Returns:
        Returns the value of the "key-manager-provider" property.
      • getKeyManagerProviderDn

        Dn getKeyManagerProviderDn()
        Gets the "key-manager-provider" property as a DN.

        Specifies the name of the key manager that should be used with this JMX Connection Handler .

        Returns:
        Returns the DN value of the "key-manager-provider" property.
      • getListenAddress

        com.forgerock.opendj.util.Host getListenAddress()
        Gets the "listen-address" property.

        Specifies the address on which this JMX Connection Handler should listen for connections from JMX clients.

        If no value is provided, then the JMX Connection Handler listens on all interfaces.

        Default value: 0.0.0.0

        Returns:
        Returns the value of the "listen-address" property.
      • getListenPort

        int getListenPort()
        Gets the "listen-port" property.

        Specifies the port number on which the JMX Connection Handler will listen for connections from clients.

        Only a single port number may be provided.

        Returns:
        Returns the value of the "listen-port" property.
      • getRmiPort

        int getRmiPort()
        Gets the "rmi-port" property.

        Specifies the port number on which the JMX RMI service will listen for connections from clients. A value of 0 indicates the service to choose a port of its own.

        If the value provided is different than 0, the value will be used as the RMI port. Otherwise, the RMI service will choose a port of its own.

        Default value: 0

        Returns:
        Returns the value of the "rmi-port" property.
      • getSslCertNickname

        SortedSet<String> getSslCertNickname()
        Gets the "ssl-cert-nickname" property.

        Specifies the nicknames (also called the aliases) of the keys or key pairs that the JMX Connection Handler should use when performing SSL communication.

        The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the JMX Connection Handler is configured to use SSL.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cert-nickname" property.
      • isUseSsl

        boolean isUseSsl()
        Gets the "use-ssl" property.

        Indicates whether the JMX Connection Handler should use SSL.

        If enabled, the JMX Connection Handler will use SSL to encrypt communication with the clients.

        Default value: false

        Returns:
        Returns the value of the "use-ssl" property.