public interface ReplicationServerCfg extends Configuration
Replication Servers publish updates to Directory Servers within a Replication Domain.
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ConfigurationChangeListener<ReplicationServerCfg> listener)
Register to be notified when this Replication Server is changed.
|
Class<? extends ReplicationServerCfg> |
configurationClass()
Gets the configuration class associated with this Replication Server.
|
ReplicationServerCfgDefn.ChangelogEnabled |
getChangelogEnabled()
Gets the "changelog-enabled" property.
|
int |
getCipherKeyLength()
Gets the "cipher-key-length" property.
|
String |
getCipherTransformation()
Gets the "cipher-transformation" property.
|
int |
getDegradedStatusThreshold()
Gets the "degraded-status-threshold" property.
|
Long |
getDiskFullThreshold()
Gets the "disk-full-threshold" property.
|
Long |
getDiskLowThreshold()
Gets the "disk-low-threshold" property.
|
String |
getGroupId()
Gets the "group-id" property.
|
SortedSet<InetAddress> |
getListenAddress()
Gets the "listen-address" property.
|
long |
getMonitoringPeriod()
Gets the "monitoring-period" property.
|
String |
getReplicationDbDirectory()
Gets the "replication-db-directory" property.
|
int |
getReplicationPort()
Gets the "replication-port" property.
|
long |
getReplicationPurgeDelay()
Gets the "replication-purge-delay" property.
|
SortedSet<String> |
getReplicationServer()
Gets the "replication-server" property.
|
String |
getReplicationServerId()
Gets the "replication-server-id" property.
|
InetAddress |
getSourceAddress()
Gets the "source-address" property.
|
int |
getWeight()
Gets the "weight" property.
|
boolean |
isConfidentialityEnabled()
Gets the "confidentiality-enabled" property.
|
void |
removeChangeListener(ConfigurationChangeListener<ReplicationServerCfg> listener)
Deregister an existing Replication Server configuration change listener.
|
dn, name
Class<? extends ReplicationServerCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<ReplicationServerCfg> listener)
listener
- The Replication Server configuration change listener.void removeChangeListener(ConfigurationChangeListener<ReplicationServerCfg> listener)
listener
- The Replication Server configuration change listener.ReplicationServerCfgDefn.ChangelogEnabled getChangelogEnabled()
Specifies whether the "cn=changelog" backend will be available to client applications.
int getCipherKeyLength()
Specifies the key length in bits for the preferred cipher.
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.
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.
int 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.
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.
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.
String 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.
SortedSet<InetAddress> getListenAddress()
Specifies the address or set of addresses on which this Replication Server should listen for connections from Replication Servers or Directory Servers.
Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the Replication Server listens on all interfaces.
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.
String getReplicationDbDirectory()
The path where the Replication Server stores all persistent information.
int getReplicationPort()
The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
long getReplicationPurgeDelay()
The time (in seconds) after which the Replication Server erases all persistent information.
SortedSet<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".
String getReplicationServerId()
Specifies a unique identifier for the Replication Server.
Each Replication Server must have a different server ID.
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.
int 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.
Copyright 2010-2022 ForgeRock AS.