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

Interface ReplicationServiceDiscoveryMechanismCfg

All Superinterfaces:
Configuration, ServiceDiscoveryMechanismCfg
public interface ReplicationServiceDiscoveryMechanismCfg extends ServiceDiscoveryMechanismCfg
A server-side interface for querying Replication Service Discovery Mechanism settings.

A Replication Service Discovery Mechanism returns the set of directory servers participating in a replication topology.

  • Method Details

    • configurationClass

      Class<? extends ReplicationServiceDiscoveryMechanismCfg> configurationClass()
      Gets the configuration class associated with this Replication Service Discovery Mechanism.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface ServiceDiscoveryMechanismCfg
      Returns:
      Returns the configuration class associated with this Replication Service Discovery Mechanism.

    • addReplicationChangeListener

      void addReplicationChangeListener(ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg> listener)
      Register to be notified when this Replication Service Discovery Mechanism is changed.
      Parameters:
      listener - The Replication Service Discovery Mechanism configuration change listener.

    • removeReplicationChangeListener

      void removeReplicationChangeListener(ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg> listener)
      Deregister an existing Replication Service Discovery Mechanism configuration change listener.
      Parameters:
      listener - The Replication Service Discovery Mechanism configuration change listener.

    • getBindDn

      Dn getBindDn()
      Gets the "bind-dn" property.

      The bind DN for periodically reading replication server configurations

      The bind DN must be present on all replication servers and directory servers, it must be able to read the server configuration.

      Default value is undefined

      Returns:
      Returns the value of the "bind-dn" property.

    • getBindPassword

      String getBindPassword()
      Gets the "bind-password" property.

      The clear-text bind password for periodically reading replication server configurations.

      The bind password must be the same on all replication and directory servers.

      Default value is undefined

      Returns:
      Returns the value of the "bind-password" property.

    • getBootstrapReplicationServer

      SortedSet<com.forgerock.opendj.util.HostPort> getBootstrapReplicationServer()
      Gets the "bootstrap-replication-server" property.

      The addresses of one or more replication servers within the topology which this server should connect to in order to discover the rest of the topology.

      Addresses must be specified using the administration port of the remote replication servers using the syntax "hostname:admin-port". When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:admin-port".

      Returns:
      Returns an unmodifiable set containing the values of the "bootstrap-replication-server" property.

    • getDiscoveryInterval

      Duration getDiscoveryInterval()
      Gets the "discovery-interval" property.

      Interval between two replication server configuration discovery queries.

      Specifies how frequently to query a replication server configuration in order to discover information about available directory server replicas.

      Default value: 60s

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

    • getJavaClass

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

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

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

      Specified by:
      getJavaClass in interface ServiceDiscoveryMechanismCfg
      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 Replication Service Discovery Mechanism.

      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 Replication Service Discovery Mechanism.

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

    • getPrimaryGroupId

      String getPrimaryGroupId()
      Gets the "primary-group-id" property.

      Replication domain group ID of preferred directory server replicas.

      Directory server replicas with this replication domain group ID will be preferred over other directory server replicas. Secondary server replicas will only be used when all primary server replicas become unavailable.

      Returns:
      Returns the value of the "primary-group-id" 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 Replication 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 Replication Service Discovery Mechanism is configured to use SSL.

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

    • getSslCipherSuite

      SortedSet<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 an unmodifiable set containing the values of the "ssl-cipher-suite" property.

    • getSslProtocol

      SortedSet<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 an unmodifiable set containing the values of the "ssl-protocol" property.

    • getTrustManagerProvider

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

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

      Default value is undefined

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

    • getTrustManagerProviderDn

      Dn getTrustManagerProviderDn()
      Gets the "trust-manager-provider" property as a DN.

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

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

    • isUseSaslExternal

      boolean isUseSaslExternal()
      Gets the "use-sasl-external" property.

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

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

    • isUseSsl

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

      Indicates whether the Replication Service Discovery Mechanism should use SSL.

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

      Default value: false

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

    • isUseStartTls

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

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

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