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

Interface StaticServiceDiscoveryMechanismCfgClient

    • Method Detail

      • getDiscoveryInterval

        ValueOrExpression<Long> getDiscoveryInterval()
        Gets the "discovery-interval" property.

        Interval between two server configuration discovery executions.

        Specifies how frequently to read the configuration of the servers in order to discover their new information.

        Default value: 60s

        Returns:
        Returns the value of the "discovery-interval" property.

      • setDiscoveryInterval

        void setDiscoveryInterval​(ValueOrExpression<Long> value)
                   throws PropertyException
        Sets the "discovery-interval" property.

        Interval between two server configuration discovery executions.

        Specifies how frequently to read the configuration of the servers in order to discover their new information.

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

      • getJavaClass

        @MandatoryProperty
ValueOrExpression<String> getJavaClass()
        Gets the "java-class" property.

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

        Default value: org.opends.server.discovery.StaticServiceDiscoveryMechanism

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

      • getKeyManagerProvider

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

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

        Default value is undefined

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

      • setKeyManagerProvider

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

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

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

      • getPrimaryServer

        SortedSet<ValueOrExpression<com.forgerock.opendj.util.HostPort>> getPrimaryServer()
        Gets the "primary-server" property.

        Specifies a list of servers that will be used in preference to secondary servers when available.

        When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

        Default value is undefined

        Returns:
        Returns the values of the "primary-server" property.

      • setPrimaryServer

        void setPrimaryServer​(Collection<ValueOrExpression<com.forgerock.opendj.util.HostPort>> values)
               throws PropertyException
        Sets the "primary-server" property.

        Specifies a list of servers that will be used in preference to secondary servers when available.

        When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

        Parameters:
        values - The values of the "primary-server" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getSecondaryServer

        SortedSet<ValueOrExpression<com.forgerock.opendj.util.HostPort>> getSecondaryServer()
        Gets the "secondary-server" property.

        Specifies a list of servers that will be used in place of primary servers when all primary servers are unavailable.

        When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

        Default value is undefined

        Returns:
        Returns the values of the "secondary-server" property.

      • setSecondaryServer

        void setSecondaryServer​(Collection<ValueOrExpression<com.forgerock.opendj.util.HostPort>> values)
                 throws PropertyException
        Sets the "secondary-server" property.

        Specifies a list of servers that will be used in place of primary servers when all primary servers are unavailable.

        When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

        Parameters:
        values - The values of the "secondary-server" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getSslCertNickname

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

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

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

      • setSslCertNickname

        void setSslCertNickname​(Collection<ValueOrExpression<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 Static 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 Static 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.

      • getSslCipherSuite

        SortedSet<ValueOrExpression<String>> getSslCipherSuite()
        Gets the "ssl-cipher-suite" property.

        Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

        Returns:
        Returns the values of the "ssl-cipher-suite" property.

      • setSslCipherSuite

        void setSslCipherSuite​(Collection<ValueOrExpression<String>> values)
                throws PropertyException
        Sets the "ssl-cipher-suite" property.

        Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

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

      • getSslProtocol

        SortedSet<ValueOrExpression<String>> getSslProtocol()
        Gets the "ssl-protocol" property.

        Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

        Returns:
        Returns the values of the "ssl-protocol" property.

      • setSslProtocol

        void setSslProtocol​(Collection<ValueOrExpression<String>> values)
             throws PropertyException
        Sets the "ssl-protocol" property.

        Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

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

      • getTrustManagerProvider

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

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

        Default value is undefined

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

      • setTrustManagerProvider

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

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

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

      • isUseSaslExternal

        ValueOrExpression<Boolean> isUseSaslExternal()
        Gets the "use-sasl-external" property.

        Indicates whether the Static Service Discovery Mechanism should use certificate based authentication when communicating with backend servers.

        If enabled, the Static Service Discovery Mechanism will use mutual TLS when connecting to backend servers. Once the TLS handshake has completed, a SASL/External LDAP bind request will be sent in order to associate the TLS client certificate with an LDAP account on the remote backend server. A key manager provider containing the client certificate must be configured in order to use this feature.

        Default value: false

        Returns:
        Returns the value of the "use-sasl-external" property.

      • setUseSaslExternal

        void setUseSaslExternal​(ValueOrExpression<Boolean> value)
                 throws PropertyException
        Sets the "use-sasl-external" property.

        Indicates whether the Static Service Discovery Mechanism should use certificate based authentication when communicating with backend servers.

        If enabled, the Static Service Discovery Mechanism will use mutual TLS when connecting to backend servers. Once the TLS handshake has completed, a SASL/External LDAP bind request will be sent in order to associate the TLS client certificate with an LDAP account on the remote backend server. A key manager provider containing the client certificate must be configured in order to use this feature.

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

      • isUseSsl

        ValueOrExpression<Boolean> isUseSsl()
        Gets the "use-ssl" property.

        Indicates whether the Static Service Discovery Mechanism should use SSL.

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

        Default value: false

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

      • setUseSsl

        void setUseSsl​(ValueOrExpression<Boolean> value)
        throws PropertyException
        Sets the "use-ssl" property.

        Indicates whether the Static Service Discovery Mechanism should use SSL.

        If enabled, the Static 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

        ValueOrExpression<Boolean> isUseStartTls()
        Gets the "use-start-tls" property.

        Indicates whether the Static Service Discovery Mechanism should use Start TLS.

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

        Default value: false

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

      • setUseStartTls

        void setUseStartTls​(ValueOrExpression<Boolean> value)
             throws PropertyException
        Sets the "use-start-tls" property.

        Indicates whether the Static Service Discovery Mechanism should use Start TLS.

        If enabled, the Static 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.