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

Interface LeaderBasedReplicationDomainCfgClient

All Superinterfaces:
ConfigurationClient
public interface LeaderBasedReplicationDomainCfgClient extends ConfigurationClient
A client-side interface for reading and modifying Leader Based Replication Domain settings.

A Leader Based Replication Domain comprises of several Directory Servers sharing the same synchronized set of data.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends LeaderBasedReplicationDomainCfgClient,? extends LeaderBasedReplicationDomainCfg> definition()
      Get the configuration definition associated with this Leader Based Replication Domain.
      Specified by:
      definition in interface ConfigurationClient
      Returns:
      Returns the configuration definition associated with this Leader Based Replication Domain.

    • getBaseDn

      @MandatoryProperty ValueOrExpression<Dn> getBaseDn()
      Gets the "base-dn" property.

      Specifies the base DN of the replicated data.

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

    • setBaseDn

      @MandatoryProperty void setBaseDn(ValueOrExpression<Dn> value) throws PropertyException, PropertyException
      Sets the "base-dn" property.

      Specifies the base DN of the replicated data.

      This property is read-only and can only be modified during creation of a Leader Based Replication Domain.

      Parameters:
      value - The value of the "base-dn" property.
      Throws:
      PropertyException - If the new value is invalid.
      PropertyException - If this Leader Based Replication Domain is not being initialized.

    • isEnabled

      ValueOrExpression<Boolean> isEnabled()
      Gets the "enabled" property.

      Indicates whether the Leader Based Replication Domain is enabled in the server.

      If a Leader Based Replication Domain is not enabled, then its contents will not be replicated.

      Default value: true

      Returns:
      Returns the value of the "enabled" property.

    • setEnabled

      void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "enabled" property.

      Indicates whether the Leader Based Replication Domain is enabled in the server.

      If a Leader Based Replication Domain is not enabled, then its contents will not be replicated.

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