Class LeaderBasedReplicationSynchronizationProviderCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<LeaderBasedReplicationSynchronizationProviderCfgClient, LeaderBasedReplicationSynchronizationProviderCfg>
org.forgerock.opendj.config.ManagedObjectDefinition<LeaderBasedReplicationSynchronizationProviderCfgClient, LeaderBasedReplicationSynchronizationProviderCfg>
org.forgerock.opendj.server.config.meta.LeaderBasedReplicationSynchronizationProviderCfgDefn
public final class LeaderBasedReplicationSynchronizationProviderCfgDefn extends ManagedObjectDefinition<LeaderBasedReplicationSynchronizationProviderCfgClient, LeaderBasedReplicationSynchronizationProviderCfg>
An interface for querying the Leader Based Replication Synchronization Provider managed object definition meta information.

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

  • Method Details

    • getInstance

      public static LeaderBasedReplicationSynchronizationProviderCfgDefn getInstance()
      Get the Leader Based Replication Synchronization Provider configuration definition singleton.
      Returns:
      Returns the Leader Based Replication Synchronization Provider configuration definition singleton.

    • createClientConfiguration

      public LeaderBasedReplicationSynchronizationProviderCfgClient createClientConfiguration(ManagedObject<? extends LeaderBasedReplicationSynchronizationProviderCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<LeaderBasedReplicationSynchronizationProviderCfgClient, LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public LeaderBasedReplicationSynchronizationProviderCfg createServerConfiguration(ServerManagedObject<? extends LeaderBasedReplicationSynchronizationProviderCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<LeaderBasedReplicationSynchronizationProviderCfgClient, LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<LeaderBasedReplicationSynchronizationProviderCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<LeaderBasedReplicationSynchronizationProviderCfgClient, LeaderBasedReplicationSynchronizationProviderCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getAdvertisedListenAddressPropertyDefinition

      public HostPropertyDefinition getAdvertisedListenAddressPropertyDefinition()
      Get the "advertised-listen-address" property definition.

      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.

      Returns:
      Returns the "advertised-listen-address" property definition.

    • getBootstrapReplicationServerPropertyDefinition

      public HostPortPropertyDefinition getBootstrapReplicationServerPropertyDefinition()
      Get the "bootstrap-replication-server" property definition.

      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 the "bootstrap-replication-server" property definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the Leader Based Replication Synchronization Provider is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

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

      Returns:
      Returns the "java-class" property definition.

    • getKeyManagerProviderPropertyDefinition

      public AggregationPropertyDefinition<KeyManagerProviderCfgClient, KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()
      Get the "key-manager-provider" property definition.

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

      Returns:
      Returns the "key-manager-provider" property definition.

    • getReplicationPortPropertyDefinition

      public IntegerPropertyDefinition getReplicationPortPropertyDefinition()
      Get the "replication-port" property definition.

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

      Returns:
      Returns the "replication-port" property definition.

    • getReplicationPurgeDelayPropertyDefinition

      public DurationPropertyDefinition getReplicationPurgeDelayPropertyDefinition()
      Get the "replication-purge-delay" property definition.

      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.

      Returns:
      Returns the "replication-purge-delay" property definition.

    • getSolveConflictsPropertyDefinition

      public BooleanPropertyDefinition getSolveConflictsPropertyDefinition()
      Get the "solve-conflicts" property definition.

      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.

      Returns:
      Returns the "solve-conflicts" property definition.

    • getSslCertNicknamePropertyDefinition

      public StringPropertyDefinition getSslCertNicknamePropertyDefinition()
      Get the "ssl-cert-nickname" property definition.

      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 the "ssl-cert-nickname" property definition.

    • getSslCipherSuitePropertyDefinition

      public StringPropertyDefinition getSslCipherSuitePropertyDefinition()
      Get the "ssl-cipher-suite" property definition.

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

      Returns:
      Returns the "ssl-cipher-suite" property definition.

    • getSslProtocolPropertyDefinition

      public StringPropertyDefinition getSslProtocolPropertyDefinition()
      Get the "ssl-protocol" property definition.

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

      Returns:
      Returns the "ssl-protocol" property definition.

    • getTrustManagerProviderPropertyDefinition

      public AggregationPropertyDefinition<TrustManagerProviderCfgClient, TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()
      Get the "trust-manager-provider" property definition.

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

      Returns:
      Returns the "trust-manager-provider" property definition.

    • getLeaderBasedReplicationDomainsRelationDefinition

      public InstantiableRelationDefinition<LeaderBasedReplicationDomainCfgClient, LeaderBasedReplicationDomainCfg> getLeaderBasedReplicationDomainsRelationDefinition()
      Get the "leader-based-replication-domains" relation definition.
      Returns:
      Returns the "leader-based-replication-domains" relation definition.