public interface ReplicationDomainCfgClient extends ConfigurationClient
A Replication Domain comprises of several Directory Servers sharing the same synchronized set of data.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends ReplicationDomainCfgClient,? extends ReplicationDomainCfg> |
definition()
Get the configuration definition associated with this Replication Domain.
|
ValueOrExpression<Integer> |
getAssuredSdLevel()
Gets the "assured-sd-level" property.
|
ValueOrExpression<Long> |
getAssuredTimeout()
Gets the "assured-timeout" property.
|
ValueOrExpression<ReplicationDomainCfgDefn.AssuredType> |
getAssuredType()
Gets the "assured-type" property.
|
ValueOrExpression<Dn> |
getBaseDn()
Gets the "base-dn" property.
|
ValueOrExpression<Long> |
getChangetimeHeartbeatInterval()
Gets the "changetime-heartbeat-interval" property.
|
ValueOrExpression<Long> |
getConflictsHistoricalPurgeDelay()
Gets the "conflicts-historical-purge-delay" property.
|
ExternalChangelogDomainCfgClient |
getExternalChangelogDomain()
Gets the External Changelog Domain.
|
SortedSet<ValueOrExpression<String>> |
getFractionalExclude()
Gets the "fractional-exclude" property.
|
SortedSet<ValueOrExpression<String>> |
getFractionalInclude()
Gets the "fractional-include" property.
|
ValueOrExpression<Integer> |
getGroupId()
Gets the "group-id" property.
|
ValueOrExpression<Long> |
getHeartbeatInterval()
Gets the "heartbeat-interval" property.
|
ValueOrExpression<Integer> |
getInitializationWindowSize()
Gets the "initialization-window-size" property.
|
ValueOrExpression<ReplicationDomainCfgDefn.IsolationPolicy> |
getIsolationPolicy()
Gets the "isolation-policy" property.
|
SortedSet<ValueOrExpression<String>> |
getReferralsUrl()
Gets the "referrals-url" property.
|
SortedSet<ValueOrExpression<String>> |
getReplicationServer()
Gets the "replication-server" property.
|
ValueOrExpression<Integer> |
getServerId()
Gets the "server-id" property.
|
ValueOrExpression<InetAddress> |
getSourceAddress()
Gets the "source-address" property.
|
ValueOrExpression<Boolean> |
isEnabled()
Gets the "enabled" property.
|
ValueOrExpression<Boolean> |
isLogChangenumber()
Gets the "log-changenumber" property.
|
ValueOrExpression<Boolean> |
isSolveConflicts()
Gets the "solve-conflicts" property.
|
void |
setAssuredSdLevel(ValueOrExpression<Integer> value)
Sets the "assured-sd-level" property.
|
void |
setAssuredTimeout(ValueOrExpression<Long> value)
Sets the "assured-timeout" property.
|
void |
setAssuredType(ValueOrExpression<ReplicationDomainCfgDefn.AssuredType> value)
Sets the "assured-type" property.
|
void |
setBaseDn(ValueOrExpression<Dn> value)
Sets the "base-dn" property.
|
void |
setChangetimeHeartbeatInterval(ValueOrExpression<Long> value)
Sets the "changetime-heartbeat-interval" property.
|
void |
setConflictsHistoricalPurgeDelay(ValueOrExpression<Long> value)
Sets the "conflicts-historical-purge-delay" property.
|
void |
setEnabled(ValueOrExpression<Boolean> value)
Sets the "enabled" property.
|
void |
setFractionalExclude(Collection<ValueOrExpression<String>> values)
Sets the "fractional-exclude" property.
|
void |
setFractionalInclude(Collection<ValueOrExpression<String>> values)
Sets the "fractional-include" property.
|
void |
setGroupId(ValueOrExpression<Integer> value)
Sets the "group-id" property.
|
void |
setHeartbeatInterval(ValueOrExpression<Long> value)
Sets the "heartbeat-interval" property.
|
void |
setInitializationWindowSize(ValueOrExpression<Integer> value)
Sets the "initialization-window-size" property.
|
void |
setIsolationPolicy(ValueOrExpression<ReplicationDomainCfgDefn.IsolationPolicy> value)
Sets the "isolation-policy" property.
|
void |
setLogChangenumber(ValueOrExpression<Boolean> value)
Sets the "log-changenumber" property.
|
void |
setReferralsUrl(Collection<ValueOrExpression<String>> values)
Sets the "referrals-url" property.
|
void |
setReplicationServer(Collection<ValueOrExpression<String>> values)
Sets the "replication-server" property.
|
void |
setServerId(ValueOrExpression<Integer> value)
Sets the "server-id" property.
|
void |
setSolveConflicts(ValueOrExpression<Boolean> value)
Sets the "solve-conflicts" property.
|
void |
setSourceAddress(ValueOrExpression<InetAddress> value)
Sets the "source-address" property.
|
commit, properties
ManagedObjectDefinition<? extends ReplicationDomainCfgClient,? extends ReplicationDomainCfg> definition()
definition
in interface ConfigurationClient
ValueOrExpression<Integer> getAssuredSdLevel()
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.
void setAssuredSdLevel(ValueOrExpression<Integer> value) throws PropertyException
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.
value
- The value of the "assured-sd-level" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getAssuredTimeout()
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.
void setAssuredTimeout(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "assured-timeout" property.PropertyException
- If the new value is invalid.ValueOrExpression<ReplicationDomainCfgDefn.AssuredType> getAssuredType()
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.
void setAssuredType(ValueOrExpression<ReplicationDomainCfgDefn.AssuredType> value) throws PropertyException
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.
value
- The value of the "assured-type" property.PropertyException
- If the new value is invalid.ValueOrExpression<Dn> getBaseDn()
Specifies the base DN of the replicated data.
void setBaseDn(ValueOrExpression<Dn> value) throws PropertyException, PropertyException
Specifies the base DN of the replicated data.
This property is read-only and can only be modified during creation of a Replication Domain.
value
- The value of the "base-dn" property.PropertyException
- If the new value is invalid.PropertyException
- If this Replication Domain is not being initialized.ValueOrExpression<Long> getChangetimeHeartbeatInterval()
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.
void setChangetimeHeartbeatInterval(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "changetime-heartbeat-interval" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getConflictsHistoricalPurgeDelay()
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.
void setConflictsHistoricalPurgeDelay(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "conflicts-historical-purge-delay" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isEnabled()
Indicates whether the Replication Domain is enabled in the server.
If a Replication Domain is not enabled, then its contents will not be replicated.
void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the Replication Domain is enabled in the server.
If a Replication Domain is not enabled, then its contents will not be replicated.
value
- The value of the "enabled" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getFractionalExclude()
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.
void setFractionalExclude(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "fractional-exclude" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getFractionalInclude()
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.
void setFractionalInclude(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "fractional-include" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getGroupId()
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).
void setGroupId(ValueOrExpression<Integer> value) throws PropertyException
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).
value
- The value of the "group-id" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getHeartbeatInterval()
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.
void setHeartbeatInterval(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "heartbeat-interval" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getInitializationWindowSize()
Specifies the window size that this directory server may use when communicating with remote Directory Servers for initialization.
void setInitializationWindowSize(ValueOrExpression<Integer> value) throws PropertyException
Specifies the window size that this directory server may use when communicating with remote Directory Servers for initialization.
value
- The value of the "initialization-window-size" property.PropertyException
- If the new value is invalid.ValueOrExpression<ReplicationDomainCfgDefn.IsolationPolicy> getIsolationPolicy()
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.
void setIsolationPolicy(ValueOrExpression<ReplicationDomainCfgDefn.IsolationPolicy> value) throws PropertyException
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.
value
- The value of the "isolation-policy" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isLogChangenumber()
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.
void setLogChangenumber(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "log-changenumber" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getReferralsUrl()
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.
void setReferralsUrl(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "referrals-url" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getReplicationServer()
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
void setReplicationServer(Collection<ValueOrExpression<String>> values) throws PropertyException
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
values
- The values of the "replication-server" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getServerId()
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.
void setServerId(ValueOrExpression<Integer> value) throws PropertyException, PropertyException
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.
value
- The value of the "server-id" property.PropertyException
- If the new value is invalid.PropertyException
- If this Replication Domain is not being initialized.ValueOrExpression<Boolean> isSolveConflicts()
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.
void setSolveConflicts(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "solve-conflicts" property.PropertyException
- If the new value is invalid.ValueOrExpression<InetAddress> getSourceAddress()
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.
void setSourceAddress(ValueOrExpression<InetAddress> value) throws PropertyException
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.
value
- The value of the "source-address" property.PropertyException
- If the new value is invalid.ExternalChangelogDomainCfgClient getExternalChangelogDomain() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
DefinitionDecodingException
- If the External Changelog Domain was found but its type
could not be determined.ManagedObjectDecodingException
- If the External Changelog Domain was found but one or
more of its properties could not be decoded.ManagedObjectNotFoundException
- If the External Changelog Domain could not be found on
the server.ConcurrentModificationException
- If this Replication Domain has been removed from the
server by another client.LdapException
- If any other error occurs.Copyright 2010-2018 ForgeRock AS.