Package org.forgerock.opendj.server.config.client

Interface ServiceDiscoveryMechanismCfgClient

    • Method Detail

      • getJavaClass

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

        Specifies the fully-qualified name of the Java class that provides the Service Discovery Mechanism implementation.

        Returns:
        Returns the value of the "java-class" property.

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Service Discovery Mechanism implementation.

        Parameters:
        value - The value of the "java-class" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getKeyManagerProvider

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

        Specifies the name of the key manager that should be used with this Service Discovery Mechanism.

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

      • setKeyManagerProvider

        void setKeyManagerProvider​(String value)
                    throws PropertyException
        Sets the "key-manager-provider" property.

        Specifies the name of the key manager that should be used with this Service Discovery Mechanism.

        Parameters:
        value - The value of the "key-manager-provider" property.
        Throws:
        PropertyException - If the new value is invalid.

      • 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 Service Discovery Mechanism 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 Service Discovery Mechanism is configured to use SSL.

        Returns:
        Returns the values of the "ssl-cert-nickname" property.

      • setSSLCertNickname

        void setSSLCertNickname​(Collection<String> values)
                 throws PropertyException
        Sets the "ssl-cert-nickname" property.

        Specifies the nicknames (also called the aliases) of the keys or key pairs that the Service Discovery Mechanism 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 Service Discovery Mechanism is configured to use SSL.

        Parameters:
        values - The values of the "ssl-cert-nickname" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getTrustManagerProvider

        String getTrustManagerProvider()
        Gets the "trust-manager-provider" property.

        Specifies the name of the trust manager that should be used with the Service Discovery Mechanism.

        Returns:
        Returns the value of the "trust-manager-provider" property.

      • setTrustManagerProvider

        void setTrustManagerProvider​(String value)
                      throws PropertyException
        Sets the "trust-manager-provider" property.

        Specifies the name of the trust manager that should be used with the Service Discovery Mechanism.

        Parameters:
        value - The value of the "trust-manager-provider" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isUseSSL

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

        Indicates whether the Service Discovery Mechanism should use SSL.

        If enabled, the Service Discovery Mechanism will use SSL to encrypt communication with the clients.

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

      • setUseSSL

        void setUseSSL​(Boolean value)
        throws PropertyException
        Sets the "use-ssl" property.

        Indicates whether the Service Discovery Mechanism should use SSL.

        If enabled, the Service Discovery Mechanism will use SSL to encrypt communication with the clients.

        Parameters:
        value - The value of the "use-ssl" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isUseStartTLS

        boolean isUseStartTLS()
        Gets the "use-start-tls" property.

        Indicates whether the Service Discovery Mechanism should use Start TLS.

        If enabled, the Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.

        Returns:
        Returns the value of the "use-start-tls" property.

      • setUseStartTLS

        void setUseStartTLS​(Boolean value)
             throws PropertyException
        Sets the "use-start-tls" property.

        Indicates whether the Service Discovery Mechanism should use Start TLS.

        If enabled, the Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.

        Parameters:
        value - The value of the "use-start-tls" property.
        Throws:
        PropertyException - If the new value is invalid.