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

Class ReplicationSynchronizationProviderCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<ReplicationSynchronizationProviderCfgClient,ReplicationSynchronizationProviderCfg>
org.forgerock.opendj.server.config.meta.ReplicationSynchronizationProviderCfgDefn
public final class ReplicationSynchronizationProviderCfgDefn extends ManagedObjectDefinition<ReplicationSynchronizationProviderCfgClient,ReplicationSynchronizationProviderCfg>
An interface for querying the Replication Synchronization Provider managed object definition meta information.

The Replication Synchronization Provider provides multi-master replication of data across multiple directory server instances.

  • Method Details

    • getInstance

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

    • createClientConfiguration

      public ReplicationSynchronizationProviderCfgClient createClientConfiguration(ManagedObject<? extends ReplicationSynchronizationProviderCfgClient> 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<ReplicationSynchronizationProviderCfgClient,ReplicationSynchronizationProviderCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

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

    • getServerConfigurationClass

      public Class<ReplicationSynchronizationProviderCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<ReplicationSynchronizationProviderCfgClient,ReplicationSynchronizationProviderCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object 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.

    • getChangetimeHeartbeatIntervalPropertyDefinition

      public DurationPropertyDefinition getChangetimeHeartbeatIntervalPropertyDefinition()
      Get the "changetime-heartbeat-interval" property definition.

      Specifies the heartbeat interval that the directory server will use when sending its local change time to the Replication Server.

      The directory server sends a regular heartbeat to the Replication within the specified interval. The heartbeat indicates the change time of the directory server to the Replication Server.

      Returns:
      Returns the "changetime-heartbeat-interval" property definition.

    • getConnectionTimeoutPropertyDefinition

      public DurationPropertyDefinition getConnectionTimeoutPropertyDefinition()
      Get the "connection-timeout" property definition.

      Specifies the timeout used when connecting to peers and when performing SSL negotiation.

      Returns:
      Returns the "connection-timeout" property definition.

    • getEnabledPropertyDefinition

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

      Indicates whether the Replication Synchronization Provider is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getHealthChecksEnabledPropertyDefinition

      public BooleanPropertyDefinition getHealthChecksEnabledPropertyDefinition()
      Get the "health-checks-enabled" property definition.

      Indicates whether the Replication Synchronization Providers health-checker is enabled.

      Returns:
      Returns the "health-checks-enabled" property definition.

    • getHeartbeatIntervalPropertyDefinition

      public DurationPropertyDefinition getHeartbeatIntervalPropertyDefinition()
      Get the "heartbeat-interval" property definition.

      Specifies the heartbeat interval that the directory server will use when communicating with Replication Servers.

      The directory server expects a regular heartbeat coming from the Replication Server within the specified interval. If a heartbeat is not received within the interval, the Directory Server closes its connection and connects to another Replication Server.

      Returns:
      Returns the "heartbeat-interval" property definition.

    • getInitializationWindowSizePropertyDefinition

      public IntegerPropertyDefinition getInitializationWindowSizePropertyDefinition()
      Get the "initialization-window-size" property definition.

      Specifies the window size that this directory server may use when communicating with remote Directory Servers for initialization.

      Returns:
      Returns the "initialization-window-size" property definition.

    • getIsolationPolicyPropertyDefinition

      public EnumPropertyDefinition<ReplicationSynchronizationProviderCfgDefn.IsolationPolicy> getIsolationPolicyPropertyDefinition()
      Get the "isolation-policy" property definition.

      Specifies the behavior of the directory server when writing to replicated data while none of the configured Replication Servers are available.

      Returns:
      Returns the "isolation-policy" property definition.

    • getJavaClassPropertyDefinition

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

      Specifies the fully-qualified name of the Java class that provides the 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 Replication Synchronization Provider.

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

    • getLogChangenumberPropertyDefinition

      public BooleanPropertyDefinition getLogChangenumberPropertyDefinition()
      Get the "log-changenumber" property definition.

      Indicates if this server logs the ChangeNumber in access log.

      This boolean indicates if the domain should log the ChangeNumber of replicated operations in the access log.

      Returns:
      Returns the "log-changenumber" property definition.

    • getMaxReplicationDelayHealthCheckPropertyDefinition

      public DurationPropertyDefinition getMaxReplicationDelayHealthCheckPropertyDefinition()
      Get the "max-replication-delay-health-check" property definition.

      The maximum replication delay for considering the Replication Synchronization Provider healthy.

      Returns:
      Returns the "max-replication-delay-health-check" property definition.

    • getNumUpdateReplayThreadsPropertyDefinition

      public IntegerPropertyDefinition getNumUpdateReplayThreadsPropertyDefinition()
      Get the "num-update-replay-threads" property definition.

      Specifies the number of update replay threads.

      This value is the number of threads created for replaying every updates received for all the replication domains.

      Returns:
      Returns the "num-update-replay-threads" property definition.

    • getReferralsUrlPropertyDefinition

      public StringPropertyDefinition getReferralsUrlPropertyDefinition()
      Get the "referrals-url" property definition.

      The URLs other LDAP servers should use to refer to the local server.

      URLs used by peer servers in the topology to refer to the local server through LDAP referrals. If this attribute is not defined, every URLs available to access this server will be used. If defined, only URLs specified here will be used.

      Returns:
      Returns the "referrals-url" 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.

    • getSourceAddressPropertyDefinition

      public HostPropertyDefinition getSourceAddressPropertyDefinition()
      Get the "source-address" property definition.

      If specified, the server will bind to the address before connecting to the remote server.

      The address must be one assigned to an existing network interface.

      Returns:
      Returns the "source-address" 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 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 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.

    • getSslEncryptionPropertyDefinition

      public BooleanPropertyDefinition getSslEncryptionPropertyDefinition()
      Get the "ssl-encryption" property definition.

      Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDJ server components.

      Returns:
      Returns the "ssl-encryption" 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 Replication Synchronization Provider .

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

    • getReplicationDomainsRelationDefinition

      public InstantiableRelationDefinition<ReplicationDomainCfgClient,ReplicationDomainCfg> getReplicationDomainsRelationDefinition()
      Get the "replication-domains" relation definition.
      Returns:
      Returns the "replication-domains" relation definition.

    • getReplicationServerRelationDefinition

      public OptionalRelationDefinition<ReplicationServerCfgClient,ReplicationServerCfg> getReplicationServerRelationDefinition()
      Get the "replication-server" relation definition.
      Returns:
      Returns the "replication-server" relation definition.