Package org.forgerock.opendj.server.config.meta

Class ReplicationServerCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<ReplicationServerCfgClient,ReplicationServerCfg>

org.forgerock.opendj.server.config.meta.ReplicationServerCfgDefn

public final class ReplicationServerCfgDefn
extends ManagedObjectDefinition<ReplicationServerCfgClient,ReplicationServerCfg>

An interface for querying the Replication Server managed object definition meta information.

Replication Servers publish updates to Directory Servers within a Replication Domain.

Method Summary

Modifier and Type	Method	Description
ReplicationServerCfgClient	createClientConfiguration(ManagedObject<? extends ReplicationServerCfgClient> impl)	Creates a client configuration view of the provided managed object.
ReplicationServerCfg	createServerConfiguration(ServerManagedObject<? extends ReplicationServerCfg> impl)	Creates a server configuration view of the provided server managed object.
DurationPropertyDefinition	getAssuredTimeoutPropertyDefinition()	Get the "assured-timeout" property definition.
IntegerPropertyDefinition	getCipherKeyLengthPropertyDefinition()	Get the "cipher-key-length" property definition.
StringPropertyDefinition	getCipherTransformationPropertyDefinition()	Get the "cipher-transformation" property definition.
BooleanPropertyDefinition	getComputeChangeNumberPropertyDefinition()	Get the "compute-change-number" property definition.
BooleanPropertyDefinition	getConfidentialityEnabledPropertyDefinition()	Get the "confidentiality-enabled" property definition.
IntegerPropertyDefinition	getDegradedStatusThresholdPropertyDefinition()	Get the "degraded-status-threshold" property definition.
IntegerPropertyDefinition	getGroupIdPropertyDefinition()	Get the "group-id" property definition.
static ReplicationServerCfgDefn	getInstance()	Get the Replication Server configuration definition singleton.
DurationPropertyDefinition	getMonitoringPeriodPropertyDefinition()	Get the "monitoring-period" property definition.
IntegerPropertyDefinition	getQueueSizePropertyDefinition()	Get the "queue-size" property definition.
StringPropertyDefinition	getReplicationDBDirectoryPropertyDefinition()	Get the "replication-db-directory" property definition.
IntegerPropertyDefinition	getReplicationPortPropertyDefinition()	Get the "replication-port" property definition.
DurationPropertyDefinition	getReplicationPurgeDelayPropertyDefinition()	Get the "replication-purge-delay" property definition.
IntegerPropertyDefinition	getReplicationServerIdPropertyDefinition()	Get the "replication-server-id" property definition.
StringPropertyDefinition	getReplicationServerPropertyDefinition()	Get the "replication-server" property definition.
Class<ReplicationServerCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
IPAddressPropertyDefinition	getSourceAddressPropertyDefinition()	Get the "source-address" property definition.
IntegerPropertyDefinition	getWeightPropertyDefinition()	Get the "weight" property definition.
IntegerPropertyDefinition	getWindowSizePropertyDefinition()	Get the "window-size" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static ReplicationServerCfgDefn getInstance()

Get the Replication Server configuration definition singleton.

Returns:

Returns the Replication Server configuration definition singleton.

createClientConfiguration

public ReplicationServerCfgClient createClientConfiguration(ManagedObject<? extends ReplicationServerCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<ReplicationServerCfgClient,ReplicationServerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public ReplicationServerCfg createServerConfiguration(ServerManagedObject<? extends ReplicationServerCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ReplicationServerCfgClient,ReplicationServerCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<ReplicationServerCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ReplicationServerCfgClient,ReplicationServerCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAssuredTimeoutPropertyDefinition

public DurationPropertyDefinition getAssuredTimeoutPropertyDefinition()

Get the "assured-timeout" property definition.

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.

Returns:

Returns the "assured-timeout" property definition.

getCipherKeyLengthPropertyDefinition

public IntegerPropertyDefinition getCipherKeyLengthPropertyDefinition()

Get the "cipher-key-length" property definition.

Specifies the key length in bits for the preferred cipher.

Returns:

Returns the "cipher-key-length" property definition.

getCipherTransformationPropertyDefinition

public StringPropertyDefinition getCipherTransformationPropertyDefinition()

Get the "cipher-transformation" property definition.

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.

Returns:

Returns the "cipher-transformation" property definition.

getComputeChangeNumberPropertyDefinition

public BooleanPropertyDefinition getComputeChangeNumberPropertyDefinition()

Get the "compute-change-number" property definition.

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.

Returns:

Returns the "compute-change-number" property definition.

getConfidentialityEnabledPropertyDefinition

public BooleanPropertyDefinition getConfidentialityEnabledPropertyDefinition()

Get the "confidentiality-enabled" property definition.

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.

Returns:

Returns the "confidentiality-enabled" property definition.

getDegradedStatusThresholdPropertyDefinition

public IntegerPropertyDefinition getDegradedStatusThresholdPropertyDefinition()

Get the "degraded-status-threshold" property definition.

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.

Returns:

Returns the "degraded-status-threshold" property definition.

getGroupIdPropertyDefinition

public IntegerPropertyDefinition getGroupIdPropertyDefinition()

Get the "group-id" property definition.

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.

Returns:

Returns the "group-id" property definition.

getMonitoringPeriodPropertyDefinition

public DurationPropertyDefinition getMonitoringPeriodPropertyDefinition()

Get the "monitoring-period" property definition.

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.

Returns:

Returns the "monitoring-period" property definition.

getQueueSizePropertyDefinition

public IntegerPropertyDefinition getQueueSizePropertyDefinition()

Get the "queue-size" property definition.

Specifies the number of changes that are kept in memory for each directory server in the Replication Domain.

Returns:

Returns the "queue-size" property definition.

getReplicationDBDirectoryPropertyDefinition

public StringPropertyDefinition getReplicationDBDirectoryPropertyDefinition()

Get the "replication-db-directory" property definition.

The path where the Replication Server stores all persistent information.

Returns:

Returns the "replication-db-directory" property definition.

getReplicationPortPropertyDefinition

public IntegerPropertyDefinition getReplicationPortPropertyDefinition()

Get the "replication-port" property definition.

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.

Returns:

Returns the "replication-port" property definition.

getReplicationPurgeDelayPropertyDefinition

public DurationPropertyDefinition getReplicationPurgeDelayPropertyDefinition()

Get the "replication-purge-delay" property definition.

The time (in seconds) after which the Replication Server erases all persistent information.

Returns:

Returns the "replication-purge-delay" property definition.

getReplicationServerPropertyDefinition

public StringPropertyDefinition getReplicationServerPropertyDefinition()

Get the "replication-server" property definition.

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".

Returns:

Returns the "replication-server" property definition.

getReplicationServerIdPropertyDefinition

public IntegerPropertyDefinition getReplicationServerIdPropertyDefinition()

Get the "replication-server-id" property definition.

Specifies a unique identifier for the Replication Server.

Each Replication Server must have a different server ID.

Returns:

Returns the "replication-server-id" property definition.

getSourceAddressPropertyDefinition

public IPAddressPropertyDefinition getSourceAddressPropertyDefinition()

Get the "source-address" property definition.

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 "source-address" property definition.

getWeightPropertyDefinition

public IntegerPropertyDefinition getWeightPropertyDefinition()

Get the "weight" property definition.

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.

Returns:

Returns the "weight" property definition.

getWindowSizePropertyDefinition

public IntegerPropertyDefinition getWindowSizePropertyDefinition()

Get the "window-size" property definition.

Specifies the window size that the Replication Server uses when communicating with other Replication Servers.

This option may be deprecated and removed in future releases.

Returns:

Returns the "window-size" property definition.