public interface ReplicationServerCfgClient extends ConfigurationClient
Replication Servers publish updates to Directory Servers within a Replication Domain.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends ReplicationServerCfgClient,? extends ReplicationServerCfg> |
definition()
Get the configuration definition associated with this Replication Server.
|
ValueOrExpression<Long> |
getAssuredTimeout()
Gets the "assured-timeout" property.
|
ValueOrExpression<Integer> |
getCipherKeyLength()
Gets the "cipher-key-length" property.
|
ValueOrExpression<String> |
getCipherTransformation()
Gets the "cipher-transformation" property.
|
ValueOrExpression<Integer> |
getDegradedStatusThreshold()
Gets the "degraded-status-threshold" property.
|
ValueOrExpression<Long> |
getDiskFullThreshold()
Gets the "disk-full-threshold" property.
|
ValueOrExpression<Long> |
getDiskLowThreshold()
Gets the "disk-low-threshold" property.
|
ValueOrExpression<Integer> |
getGroupId()
Gets the "group-id" property.
|
ValueOrExpression<Long> |
getMonitoringPeriod()
Gets the "monitoring-period" property.
|
ValueOrExpression<String> |
getReplicationDbDirectory()
Gets the "replication-db-directory" property.
|
ValueOrExpression<Integer> |
getReplicationPort()
Gets the "replication-port" property.
|
ValueOrExpression<Long> |
getReplicationPurgeDelay()
Gets the "replication-purge-delay" property.
|
SortedSet<ValueOrExpression<String>> |
getReplicationServer()
Gets the "replication-server" property.
|
ValueOrExpression<Integer> |
getReplicationServerId()
Gets the "replication-server-id" property.
|
ValueOrExpression<InetAddress> |
getSourceAddress()
Gets the "source-address" property.
|
ValueOrExpression<Integer> |
getWeight()
Gets the "weight" property.
|
ValueOrExpression<Boolean> |
isComputeChangeNumber()
Gets the "compute-change-number" property.
|
ValueOrExpression<Boolean> |
isConfidentialityEnabled()
Gets the "confidentiality-enabled" property.
|
void |
setAssuredTimeout(ValueOrExpression<Long> value)
Sets the "assured-timeout" property.
|
void |
setCipherKeyLength(ValueOrExpression<Integer> value)
Sets the "cipher-key-length" property.
|
void |
setCipherTransformation(ValueOrExpression<String> value)
Sets the "cipher-transformation" property.
|
void |
setComputeChangeNumber(ValueOrExpression<Boolean> value)
Sets the "compute-change-number" property.
|
void |
setConfidentialityEnabled(ValueOrExpression<Boolean> value)
Sets the "confidentiality-enabled" property.
|
void |
setDegradedStatusThreshold(ValueOrExpression<Integer> value)
Sets the "degraded-status-threshold" property.
|
void |
setDiskFullThreshold(ValueOrExpression<Long> value)
Sets the "disk-full-threshold" property.
|
void |
setDiskLowThreshold(ValueOrExpression<Long> value)
Sets the "disk-low-threshold" property.
|
void |
setGroupId(ValueOrExpression<Integer> value)
Sets the "group-id" property.
|
void |
setMonitoringPeriod(ValueOrExpression<Long> value)
Sets the "monitoring-period" property.
|
void |
setReplicationDbDirectory(ValueOrExpression<String> value)
Sets the "replication-db-directory" property.
|
void |
setReplicationPort(ValueOrExpression<Integer> value)
Sets the "replication-port" property.
|
void |
setReplicationPurgeDelay(ValueOrExpression<Long> value)
Sets the "replication-purge-delay" property.
|
void |
setReplicationServer(Collection<ValueOrExpression<String>> values)
Sets the "replication-server" property.
|
void |
setReplicationServerId(ValueOrExpression<Integer> value)
Sets the "replication-server-id" property.
|
void |
setSourceAddress(ValueOrExpression<InetAddress> value)
Sets the "source-address" property.
|
void |
setWeight(ValueOrExpression<Integer> value)
Sets the "weight" property.
|
commit, properties
ManagedObjectDefinition<? extends ReplicationServerCfgClient,? extends ReplicationServerCfg> definition()
definition
in interface ConfigurationClient
ValueOrExpression<Long> getAssuredTimeout()
The timeout value when waiting for assured mode acknowledgments.
Defines the number of milliseconds that the replication server will wait for assured acknowledgments (in either Safe Data or Safe Read assured sub modes) before forgetting them and answer to the entity that sent an update and is waiting for acknowledgment.
void setAssuredTimeout(ValueOrExpression<Long> value) throws PropertyException
The timeout value when waiting for assured mode acknowledgments.
Defines the number of milliseconds that the replication server will wait for assured acknowledgments (in either Safe Data or Safe Read assured sub modes) before forgetting them and answer to the entity that sent an update and is waiting for acknowledgment.
value
- The value of the "assured-timeout" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getCipherKeyLength()
Specifies the key length in bits for the preferred cipher.
void setCipherKeyLength(ValueOrExpression<Integer> value) throws PropertyException
Specifies the key length in bits for the preferred cipher.
value
- The value of the "cipher-key-length" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getCipherTransformation()
Specifies the cipher for the directory server. The syntax is "algorithm/mode/padding".
The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.
void setCipherTransformation(ValueOrExpression<String> value) throws PropertyException
Specifies the cipher for the directory server. The syntax is "algorithm/mode/padding".
The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.
value
- The value of the "cipher-transformation" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isComputeChangeNumber()
Whether the replication server will compute change numbers.
This boolean tells the replication server to compute change numbers for each replicated change by maintaining a change number index database. Changenumbers are computed according to http://tools.ietf.org/html/draft-good-ldap-changelog-04. Note this functionality has an impact on CPU, disk accesses and storage. If changenumbers are not required, it is advisable to set this value to false.
void setComputeChangeNumber(ValueOrExpression<Boolean> value) throws PropertyException
Whether the replication server will compute change numbers.
This boolean tells the replication server to compute change numbers for each replicated change by maintaining a change number index database. Changenumbers are computed according to http://tools.ietf.org/html/draft-good-ldap-changelog-04. Note this functionality has an impact on CPU, disk accesses and storage. If changenumbers are not required, it is advisable to set this value to false.
value
- The value of the "compute-change-number" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isConfidentialityEnabled()
Indicates whether the replication change-log should make records readable only by Directory Server. Throughput and disk space are affected by the more expensive operations taking place.
Confidentiality is achieved by encrypting records on all domains managed by this replication server. Encrypting the records prevents unauthorized parties from accessing contents of LDAP operations. For complete protection, consider enabling secure communications between servers. Change number indexing is not affected by the setting.
void setConfidentialityEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the replication change-log should make records readable only by Directory Server. Throughput and disk space are affected by the more expensive operations taking place.
Confidentiality is achieved by encrypting records on all domains managed by this replication server. Encrypting the records prevents unauthorized parties from accessing contents of LDAP operations. For complete protection, consider enabling secure communications between servers. Change number indexing is not affected by the setting.
value
- The value of the "confidentiality-enabled" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getDegradedStatusThreshold()
The number of pending changes as threshold value for putting a directory server in degraded status.
This value represents a number of pending changes a replication server has in queue for sending to a directory server. Once this value is crossed, the matching directory server goes in degraded status. When number of pending changes goes back under this value, the directory server is put back in normal status. 0 means status analyzer is disabled and directory servers are never put in degraded status.
void setDegradedStatusThreshold(ValueOrExpression<Integer> value) throws PropertyException
The number of pending changes as threshold value for putting a directory server in degraded status.
This value represents a number of pending changes a replication server has in queue for sending to a directory server. Once this value is crossed, the matching directory server goes in degraded status. When number of pending changes goes back under this value, the directory server is put back in normal status. 0 means status analyzer is disabled and directory servers are never put in degraded status.
value
- The value of the "degraded-status-threshold" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getDiskFullThreshold()
The free disk space threshold at which point a warning alert notification will be triggered and the replication server will disconnect from the rest of the replication topology.
When the available free space on the disk used by the replication changelog falls below the value specified, this replication server will stop. Connected Directory Servers will fail over to another RS. The replication server will restart again as soon as free space rises above the low threshold.
void setDiskFullThreshold(ValueOrExpression<Long> value) throws PropertyException
The free disk space threshold at which point a warning alert notification will be triggered and the replication server will disconnect from the rest of the replication topology.
When the available free space on the disk used by the replication changelog falls below the value specified, this replication server will stop. Connected Directory Servers will fail over to another RS. The replication server will restart again as soon as free space rises above the low threshold.
value
- The value of the "disk-full-threshold" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getDiskLowThreshold()
The free disk space threshold at which point a warning alert notification will be triggered.
When the available free space on the disk used by the replication changelog falls below the value specified, a warning is sent and logged. Normal operation will continue but administrators are advised to take action to free some disk space.
void setDiskLowThreshold(ValueOrExpression<Long> value) throws PropertyException
The free disk space threshold at which point a warning alert notification will be triggered.
When the available free space on the disk used by the replication changelog falls below the value specified, a warning is sent and logged. Normal operation will continue but administrators are advised to take action to free some disk space.
value
- The value of the "disk-low-threshold" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getGroupId()
The group id for the replication server.
This value defines the group id of the replication server. The replication system of a LDAP server uses the group id of the replicated domain and tries to connect, if possible, to a replication with the same group id.
void setGroupId(ValueOrExpression<Integer> value) throws PropertyException
The group id for the replication server.
This value defines the group id of the replication server. The replication system of a LDAP server uses the group id of the replicated domain and tries to connect, if possible, to a replication with the same group id.
value
- The value of the "group-id" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getMonitoringPeriod()
The period between sending of monitoring messages.
Defines the duration that the replication server will wait before sending new monitoring messages to its peers (replication servers and directory servers). Larger values increase the length of time it takes for a directory server to detect and switch to a more suitable replication server, whereas smaller values increase the amount of background network traffic.
void setMonitoringPeriod(ValueOrExpression<Long> value) throws PropertyException
The period between sending of monitoring messages.
Defines the duration that the replication server will wait before sending new monitoring messages to its peers (replication servers and directory servers). Larger values increase the length of time it takes for a directory server to detect and switch to a more suitable replication server, whereas smaller values increase the amount of background network traffic.
value
- The value of the "monitoring-period" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getReplicationDbDirectory()
The path where the Replication Server stores all persistent information.
void setReplicationDbDirectory(ValueOrExpression<String> value) throws PropertyException, PropertyException
The path where the Replication Server stores all persistent information.
This property is read-only and can only be modified during creation of a Replication Server.
value
- The value of the "replication-db-directory" property.PropertyException
- If the new value is invalid.PropertyException
- If this Replication Server is not being initialized.ValueOrExpression<Integer> getReplicationPort()
The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
void setReplicationPort(ValueOrExpression<Integer> value) throws PropertyException
The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
value
- The value of the "replication-port" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getReplicationPurgeDelay()
The time (in seconds) after which the Replication Server erases all persistent information.
void setReplicationPurgeDelay(ValueOrExpression<Long> value) throws PropertyException
The time (in seconds) after which the Replication Server erases all persistent information.
value
- The value of the "replication-purge-delay" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getReplicationServer()
Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
Addresses must be specified using the syntax: "hostname:port". If IPv6 addresses are used as the hostname, they must be specified using the syntax "[IPv6Address]:port".
void setReplicationServer(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
Addresses must be specified using the syntax: "hostname:port". If IPv6 addresses are used as the hostname, they must be specified using the syntax "[IPv6Address]:port".
values
- The values of the "replication-server" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getReplicationServerId()
Specifies a unique identifier for the Replication Server.
Each Replication Server must have a different server ID.
void setReplicationServerId(ValueOrExpression<Integer> value) throws PropertyException, PropertyException
Specifies a unique identifier for the Replication Server.
Each Replication Server must have a different server ID.
This property is read-only and can only be modified during creation of a Replication Server.
value
- The value of the "replication-server-id" property.PropertyException
- If the new value is invalid.PropertyException
- If this Replication Server is not being initialized.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.ValueOrExpression<Integer> getWeight()
The weight of the replication server.
The weight affected to the replication server. Each replication server of the topology has a weight. When combined together, the weights of the replication servers of a same group can be translated to a percentage that determines the quantity of directory servers of the topology that should be connected to a replication server. For instance imagine a topology with 3 replication servers (with the same group id) with the following weights: RS1=1, RS2=1, RS3=2. This means that RS1 should have 25% of the directory servers connected in the topology, RS2 25%, and RS3 50%. This may be useful if the replication servers of the topology have a different power and one wants to spread the load between the replication servers according to their power.
void setWeight(ValueOrExpression<Integer> value) throws PropertyException
The weight of the replication server.
The weight affected to the replication server. Each replication server of the topology has a weight. When combined together, the weights of the replication servers of a same group can be translated to a percentage that determines the quantity of directory servers of the topology that should be connected to a replication server. For instance imagine a topology with 3 replication servers (with the same group id) with the following weights: RS1=1, RS2=1, RS3=2. This means that RS1 should have 25% of the directory servers connected in the topology, RS2 25%, and RS3 50%. This may be useful if the replication servers of the topology have a different power and one wants to spread the load between the replication servers according to their power.
value
- The value of the "weight" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.