Interface LeaderBasedReplicationSynchronizationProviderCfg

All Superinterfaces:
Configuration, SynchronizationProviderCfg
public interface LeaderBasedReplicationSynchronizationProviderCfg extends SynchronizationProviderCfg
A server-side interface for querying Leader Based Replication Synchronization Provider settings.

The Leader Based Replication Synchronization Provider provides leader based eventually consistent replication of data across multiple directory server instances.

  • Method Details

    • configurationClass

      Class<? extends LeaderBasedReplicationSynchronizationProviderCfg> configurationClass()
      Gets the configuration class associated with this Leader Based Replication Synchronization Provider.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface SynchronizationProviderCfg
      Returns:
      Returns the configuration class associated with this Leader Based Replication Synchronization Provider.

    • addLeaderBasedReplicationChangeListener

      void addLeaderBasedReplicationChangeListener(ConfigurationChangeListener<LeaderBasedReplicationSynchronizationProviderCfg> listener)
      Register to be notified when this Leader Based Replication Synchronization Provider is changed.
      Parameters:
      listener - The Leader Based Replication Synchronization Provider configuration change listener.

    • removeLeaderBasedReplicationChangeListener

      void removeLeaderBasedReplicationChangeListener(ConfigurationChangeListener<LeaderBasedReplicationSynchronizationProviderCfg> listener)
      Deregister an existing Leader Based Replication Synchronization Provider configuration change listener.
      Parameters:
      listener - The Leader Based Replication Synchronization Provider configuration change listener.

    • getAdvertisedListenAddress

      SortedSet<com.forgerock.opendj.util.Host> getAdvertisedListenAddress()
      Gets the "advertised-listen-address" property.

      The advertised address(es) which clients should use for connecting to this Leader Based Replication Synchronization Provider.

      Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted.

      Default value is inherited from another property

      Returns:
      Returns an unmodifiable set containing the values of the "advertised-listen-address" 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 replication port of the remote replication servers using the syntax "hostname:repl-port". When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:repl-port".

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

    • getJavaClass

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

      Specifies the fully-qualified name of the Java class that provides the Leader Based Replication Synchronization Provider implementation.

      Default value: org.forgerock.opendj.server.leaderbasedreplication.LeaderBasedReplication

      Specified by:
      getJavaClass in interface SynchronizationProviderCfg
      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 Leader Based Replication Synchronization Provider.

      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 Leader Based Replication Synchronization Provider.

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

    • getReplicationPort

      int getReplicationPort()
      Gets the "replication-port" property.

      The port on which the directory server listens for the replication LDAP traffic.

      Returns:
      Returns the value of the "replication-port" property.

    • getReplicationPurgeDelay

      Duration getReplicationPurgeDelay()
      Gets the "replication-purge-delay" property.

      Minimum lifetime of changelog data and old replication meta-data in directory entries. Changelog data and replication meta-data older than this setting is eligible to be removed.

      After the purge delay has passed, the server removes old changelog data over time when it applies new updates. Replication meta-data is stored in changed directory entries. The server removes old replication meta-data either when the entry is next modified, or by a dedicated purge task, whichever happens first. The server temporarily stops removing old data when it has been unable to process updates for an extended period of time. For example, the server stops removing data when the server is offline, and when it cannot access other servers due to a network partition. Once old data is removed, the server can no longer use it for replication. Changelog and replication meta-data older than the purge delay must therefore be considered stale. Backups must be newer than the purge delay, including the time it takes to restore a backup.

      Default value: 3 days

      Returns:
      Returns the value of the "replication-purge-delay" property.

    • isSolveConflicts

      boolean isSolveConflicts()
      Gets the "solve-conflicts" property.

      Indicates if this server solves conflict.

      This boolean indicates if this domain keeps the historical meta-data necessary to solve conflicts. When set to false the server will not maintain historical meta-data and will therefore not be able to solve conflict. This should therefore be done only if the replication is used in a single master type of deployment.

      Default value: true

      Returns:
      Returns the value of the "solve-conflicts" 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 Leader Based Replication Synchronization Provider 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 Leader Based Replication Synchronization Provider 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

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

      Specifies the name of the trust manager that should be used with the Leader Based Replication Synchronization Provider.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "trust-manager-provider" property.

    • getTrustManagerProviderDns

      SortedSet<Dn> getTrustManagerProviderDns()
      Gets the "trust-manager-provider" property as a set of DNs.

      Specifies the name of the trust manager that should be used with the Leader Based Replication Synchronization Provider.

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

    • listLeaderBasedReplicationDomains

      String[] listLeaderBasedReplicationDomains()
      Lists the Leader Based Replication Domains.
      Returns:
      Returns an array containing the names of the Leader Based Replication Domains.

    • getLeaderBasedReplicationDomain

      LeaderBasedReplicationDomainCfg getLeaderBasedReplicationDomain(String name) throws ConfigException
      Gets the named Leader Based Replication Domain.
      Parameters:
      name - The name of the Leader Based Replication Domain to retrieve.
      Returns:
      Returns the named Leader Based Replication Domain.
      Throws:
      ConfigException - If the Leader Based Replication Domain could not be found or it could not be successfully decoded.

    • addLeaderBasedReplicationDomainAddListener

      void addLeaderBasedReplicationDomainAddListener(ConfigurationAddListener<LeaderBasedReplicationDomainCfg> listener) throws ConfigException
      Registers to be notified when new Leader Based Replication Domains are added.
      Parameters:
      listener - The Leader Based Replication Domain configuration add listener.
      Throws:
      ConfigException - If the add listener could not be registered.

    • removeLeaderBasedReplicationDomainAddListener

      void removeLeaderBasedReplicationDomainAddListener(ConfigurationAddListener<LeaderBasedReplicationDomainCfg> listener)
      Deregisters an existing Leader Based Replication Domain configuration add listener.
      Parameters:
      listener - The Leader Based Replication Domain configuration add listener.

    • addLeaderBasedReplicationDomainDeleteListener

      void addLeaderBasedReplicationDomainDeleteListener(ConfigurationDeleteListener<LeaderBasedReplicationDomainCfg> listener) throws ConfigException
      Registers to be notified when existing Leader Based Replication Domains are deleted.
      Parameters:
      listener - The Leader Based Replication Domain configuration delete listener.
      Throws:
      ConfigException - If the delete listener could not be registered.

    • removeLeaderBasedReplicationDomainDeleteListener

      void removeLeaderBasedReplicationDomainDeleteListener(ConfigurationDeleteListener<LeaderBasedReplicationDomainCfg> listener)
      Deregisters an existing Leader Based Replication Domain configuration delete listener.
      Parameters:
      listener - The Leader Based Replication Domain configuration delete listener.