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

Interface ReplicationDomainCfgClient

  • All Superinterfaces:
    ConfigurationClient
    public interface ReplicationDomainCfgClient
extends ConfigurationClient
    A client-side interface for reading and modifying Replication Domain settings.

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

    • Method Detail

      • getAssuredSdLevel

        int getAssuredSdLevel()
        Gets the "assured-sd-level" property.

        The level of acknowledgment for Safe Data assured sub mode.

        When assured replication is configured in Safe Data mode, this value defines the number of replication servers (with the same group ID of the local server) that should acknowledge the sent update before the LDAP client call can return.

        Returns:
        Returns the value of the "assured-sd-level" property.

      • setAssuredSdLevel

        void setAssuredSdLevel​(Integer value)
                throws PropertyException
        Sets the "assured-sd-level" property.

        The level of acknowledgment for Safe Data assured sub mode.

        When assured replication is configured in Safe Data mode, this value defines the number of replication servers (with the same group ID of the local server) that should acknowledge the sent update before the LDAP client call can return.

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

      • getAssuredTimeout

        long getAssuredTimeout()
        Gets the "assured-timeout" property.

        The timeout value when waiting for assured replication acknowledgments.

        Defines the amount of milliseconds the server will wait for assured acknowledgments (in either Safe Data or Safe Read assured replication modes) before returning anyway the LDAP client call.

        Returns:
        Returns the value of the "assured-timeout" property.

      • setAssuredTimeout

        void setAssuredTimeout​(Long value)
                throws PropertyException
        Sets the "assured-timeout" property.

        The timeout value when waiting for assured replication acknowledgments.

        Defines the amount of milliseconds the server will wait for assured acknowledgments (in either Safe Data or Safe Read assured replication modes) before returning anyway the LDAP client call.

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

      • getAssuredType

        ReplicationDomainCfgDefn.AssuredType getAssuredType()
        Gets the "assured-type" property.

        Defines the assured replication mode of the replicated domain.

        The assured replication can be disabled or enabled. When enabled, two modes are available: Safe Data or Safe Read modes.

        Returns:
        Returns the value of the "assured-type" property.

      • setAssuredType

        void setAssuredType​(ReplicationDomainCfgDefn.AssuredType value)
             throws PropertyException
        Sets the "assured-type" property.

        Defines the assured replication mode of the replicated domain.

        The assured replication can be disabled or enabled. When enabled, two modes are available: Safe Data or Safe Read modes.

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

      • getBaseDN

        org.forgerock.opendj.ldap.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

        void setBaseDN​(org.forgerock.opendj.ldap.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 Replication Domain.

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

      • getChangetimeHeartbeatInterval

        long getChangetimeHeartbeatInterval()
        Gets the "changetime-heartbeat-interval" property.

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

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

        Returns:
        Returns the value of the "changetime-heartbeat-interval" property.

      • setChangetimeHeartbeatInterval

        void setChangetimeHeartbeatInterval​(Long value)
                             throws PropertyException
        Sets the "changetime-heartbeat-interval" property.

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

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

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

      • getConflictsHistoricalPurgeDelay

        long getConflictsHistoricalPurgeDelay()
        Gets the "conflicts-historical-purge-delay" property.

        This delay indicates the time (in minutes) the domain keeps the historical information necessary to solve conflicts.When a change stored in the historical part of the user entry has a date (from its replication ChangeNumber) older than this delay, it is candidate to be purged. The purge is applied on 2 events: modify of the entry, dedicated purge task.

        Returns:
        Returns the value of the "conflicts-historical-purge-delay" property.

      • setConflictsHistoricalPurgeDelay

        void setConflictsHistoricalPurgeDelay​(Long value)
                               throws PropertyException
        Sets the "conflicts-historical-purge-delay" property.

        This delay indicates the time (in minutes) the domain keeps the historical information necessary to solve conflicts.When a change stored in the historical part of the user entry has a date (from its replication ChangeNumber) older than this delay, it is candidate to be purged. The purge is applied on 2 events: modify of the entry, dedicated purge task.

        Parameters:
        value - The value of the "conflicts-historical-purge-delay" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getFractionalExclude

        SortedSet<String> getFractionalExclude()
        Gets the "fractional-exclude" property.

        Allows to exclude some attributes to replicate to this server.

        If fractional-exclude configuration attribute is used, attributes specified in this attribute will be ignored (not added/modified/deleted) when an operation performed from another directory server is being replayed in the local server. Note that the usage of this configuration attribute is mutually exclusive with the usage of the fractional-include attribute.

        Returns:
        Returns the values of the "fractional-exclude" property.

      • setFractionalExclude

        void setFractionalExclude​(Collection<String> values)
                   throws PropertyException
        Sets the "fractional-exclude" property.

        Allows to exclude some attributes to replicate to this server.

        If fractional-exclude configuration attribute is used, attributes specified in this attribute will be ignored (not added/modified/deleted) when an operation performed from another directory server is being replayed in the local server. Note that the usage of this configuration attribute is mutually exclusive with the usage of the fractional-include attribute.

        Parameters:
        values - The values of the "fractional-exclude" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getFractionalInclude

        SortedSet<String> getFractionalInclude()
        Gets the "fractional-include" property.

        Allows to include some attributes to replicate to this server.

        If fractional-include configuration attribute is used, only attributes specified in this attribute will be added/modified/deleted when an operation performed from another directory server is being replayed in the local server. Note that the usage of this configuration attribute is mutually exclusive with the usage of the fractional-exclude attribute.

        Returns:
        Returns the values of the "fractional-include" property.

      • setFractionalInclude

        void setFractionalInclude​(Collection<String> values)
                   throws PropertyException
        Sets the "fractional-include" property.

        Allows to include some attributes to replicate to this server.

        If fractional-include configuration attribute is used, only attributes specified in this attribute will be added/modified/deleted when an operation performed from another directory server is being replayed in the local server. Note that the usage of this configuration attribute is mutually exclusive with the usage of the fractional-exclude attribute.

        Parameters:
        values - The values of the "fractional-include" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getGroupId

        int getGroupId()
        Gets the "group-id" property.

        The group ID associated with this replicated domain.

        This value defines the group ID of the replicated domain. The replication system will preferably connect and send updates to replicate to a replication server with the same group ID as its own one (the local server group ID).

        Returns:
        Returns the value of the "group-id" property.

      • setGroupId

        void setGroupId​(Integer value)
         throws PropertyException
        Sets the "group-id" property.

        The group ID associated with this replicated domain.

        This value defines the group ID of the replicated domain. The replication system will preferably connect and send updates to replicate to a replication server with the same group ID as its own one (the local server group ID).

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

      • getHeartbeatInterval

        long getHeartbeatInterval()
        Gets the "heartbeat-interval" property.

        Specifies the heart-beat interval that the directory server will use when communicating with Replication Servers.

        The directory server expects a regular heart-beat 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 value of the "heartbeat-interval" property.

      • setHeartbeatInterval

        void setHeartbeatInterval​(Long value)
                   throws PropertyException
        Sets the "heartbeat-interval" property.

        Specifies the heart-beat interval that the directory server will use when communicating with Replication Servers.

        The directory server expects a regular heart-beat 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.

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

      • getInitializationWindowSize

        int getInitializationWindowSize()
        Gets the "initialization-window-size" property.

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

        Returns:
        Returns the value of the "initialization-window-size" property.

      • setInitializationWindowSize

        void setInitializationWindowSize​(Integer value)
                          throws PropertyException
        Sets the "initialization-window-size" property.

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

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

      • getIsolationPolicy

        ReplicationDomainCfgDefn.IsolationPolicy getIsolationPolicy()
        Gets the "isolation-policy" property.

        Specifies the behavior of the directory server if a write operation is attempted on the data within the Replication Domain when none of the configured Replication Servers are available.

        Returns:
        Returns the value of the "isolation-policy" property.

      • setIsolationPolicy

        void setIsolationPolicy​(ReplicationDomainCfgDefn.IsolationPolicy value)
                 throws PropertyException
        Sets the "isolation-policy" property.

        Specifies the behavior of the directory server if a write operation is attempted on the data within the Replication Domain when none of the configured Replication Servers are available.

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

      • isLogChangenumber

        boolean isLogChangenumber()
        Gets the "log-changenumber" property.

        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 value of the "log-changenumber" property.

      • setLogChangenumber

        void setLogChangenumber​(Boolean value)
                 throws PropertyException
        Sets the "log-changenumber" property.

        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.

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

      • getReferralsUrl

        SortedSet<String> getReferralsUrl()
        Gets the "referrals-url" property.

        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 values of the "referrals-url" property.

      • setReferralsUrl

        void setReferralsUrl​(Collection<String> values)
              throws PropertyException
        Sets the "referrals-url" property.

        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.

        Parameters:
        values - The values of the "referrals-url" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getReplicationServer

        SortedSet<String> getReplicationServer()
        Gets the "replication-server" property.

        Specifies the addresses of the Replication Servers within the Replication Domain to which the directory server should try to connect at startup time.

        Addresses must be specified using the syntax: hostname:port

        Returns:
        Returns the values of the "replication-server" property.

      • setReplicationServer

        void setReplicationServer​(Collection<String> values)
                   throws PropertyException
        Sets the "replication-server" property.

        Specifies the addresses of the Replication Servers within the Replication Domain to which the directory server should try to connect at startup time.

        Addresses must be specified using the syntax: hostname:port

        Parameters:
        values - The values of the "replication-server" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getServerId

        Integer getServerId()
        Gets the "server-id" property.

        Specifies a unique identifier for the directory server within the Replication Domain.

        Each directory server within the same Replication Domain must have a different server ID. A directory server which is a member of multiple Replication Domains may use the same server ID for each of its Replication Domain configurations.

        Returns:
        Returns the value of the "server-id" property.

      • setServerId

        void setServerId​(int value)
          throws PropertyException,
                 PropertyException
        Sets the "server-id" property.

        Specifies a unique identifier for the directory server within the Replication Domain.

        Each directory server within the same Replication Domain must have a different server ID. A directory server which is a member of multiple Replication Domains may use the same server ID for each of its Replication Domain configurations.

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

        Parameters:
        value - The value of the "server-id" property.
        Throws:
        PropertyException - If the new value is invalid.
        PropertyException - If this Replication Domain is not being initialized.

      • isSolveConflicts

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

        Indicates if this server solves conflict.

        This boolean indicates if this domain keeps the historical information necessary to solve conflicts. When set to false the server will not maintain historical information 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 value of the "solve-conflicts" property.

      • setSolveConflicts

        void setSolveConflicts​(Boolean value)
                throws PropertyException
        Sets the "solve-conflicts" property.

        Indicates if this server solves conflict.

        This boolean indicates if this domain keeps the historical information necessary to solve conflicts. When set to false the server will not maintain historical information 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.

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

      • getSourceAddress

        InetAddress getSourceAddress()
        Gets the "source-address" property.

        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 value of the "source-address" property.

      • setSourceAddress

        void setSourceAddress​(InetAddress value)
               throws PropertyException
        Sets the "source-address" property.

        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.

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

      • getWindowSize

        int getWindowSize()
        Gets the "window-size" property.

        Specifies the window size that the directory server will use when communicating with Replication Servers.

        This option may be deprecated and removed in future releases.

        Returns:
        Returns the value of the "window-size" property.

      • setWindowSize

        void setWindowSize​(Integer value)
            throws PropertyException
        Sets the "window-size" property.

        Specifies the window size that the directory server will use when communicating with Replication Servers.

        This option may be deprecated and removed in future releases.

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