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

Class ReplicationDomainCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ReplicationDomainCfgClient,ReplicationDomainCfg>

org.forgerock.opendj.server.config.meta.ReplicationDomainCfgDefn

public final class ReplicationDomainCfgDefn
extends ManagedObjectDefinition<ReplicationDomainCfgClient,ReplicationDomainCfg>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReplicationDomainCfgDefn.AssuredType	Defines the set of permissable values for the "assured-type" property.
static class	ReplicationDomainCfgDefn.IsolationPolicy	Defines the set of permissable values for the "isolation-policy" property.

Method Summary

Modifier and Type	Method	Description
ReplicationDomainCfgClient	createClientConfiguration(ManagedObject<? extends ReplicationDomainCfgClient> impl)	Creates a client configuration view of the provided managed object.
ReplicationDomainCfg	createServerConfiguration(ServerManagedObject<? extends ReplicationDomainCfg> impl)	Creates a server configuration view of the provided server managed object.
IntegerPropertyDefinition	getAssuredSdLevelPropertyDefinition()	Get the "assured-sd-level" property definition.
DurationPropertyDefinition	getAssuredTimeoutPropertyDefinition()	Get the "assured-timeout" property definition.
EnumPropertyDefinition<ReplicationDomainCfgDefn.AssuredType>	getAssuredTypePropertyDefinition()	Get the "assured-type" property definition.
DNPropertyDefinition	getBaseDNPropertyDefinition()	Get the "base-dn" property definition.
DurationPropertyDefinition	getChangetimeHeartbeatIntervalPropertyDefinition()	Get the "changetime-heartbeat-interval" property definition.
DurationPropertyDefinition	getConflictsHistoricalPurgeDelayPropertyDefinition()	Get the "conflicts-historical-purge-delay" property definition.
SingletonRelationDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg>	getExternalChangelogDomainRelationDefinition()	Get the "external-changelog-domain" relation definition.
StringPropertyDefinition	getFractionalExcludePropertyDefinition()	Get the "fractional-exclude" property definition.
StringPropertyDefinition	getFractionalIncludePropertyDefinition()	Get the "fractional-include" property definition.
IntegerPropertyDefinition	getGroupIdPropertyDefinition()	Get the "group-id" property definition.
DurationPropertyDefinition	getHeartbeatIntervalPropertyDefinition()	Get the "heartbeat-interval" property definition.
IntegerPropertyDefinition	getInitializationWindowSizePropertyDefinition()	Get the "initialization-window-size" property definition.
static ReplicationDomainCfgDefn	getInstance()	Get the Replication Domain configuration definition singleton.
EnumPropertyDefinition<ReplicationDomainCfgDefn.IsolationPolicy>	getIsolationPolicyPropertyDefinition()	Get the "isolation-policy" property definition.
BooleanPropertyDefinition	getLogChangenumberPropertyDefinition()	Get the "log-changenumber" property definition.
StringPropertyDefinition	getReferralsUrlPropertyDefinition()	Get the "referrals-url" property definition.
StringPropertyDefinition	getReplicationServerPropertyDefinition()	Get the "replication-server" property definition.
Class<ReplicationDomainCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
IntegerPropertyDefinition	getServerIdPropertyDefinition()	Get the "server-id" property definition.
BooleanPropertyDefinition	getSolveConflictsPropertyDefinition()	Get the "solve-conflicts" property definition.
IPAddressPropertyDefinition	getSourceAddressPropertyDefinition()	Get the "source-address" 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 ReplicationDomainCfgDefn getInstance()

Get the Replication Domain configuration definition singleton.

Returns:

Returns the Replication Domain configuration definition singleton.

createClientConfiguration

public ReplicationDomainCfgClient createClientConfiguration(ManagedObject<? extends ReplicationDomainCfgClient> 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<ReplicationDomainCfgClient,ReplicationDomainCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ReplicationDomainCfgClient,ReplicationDomainCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ReplicationDomainCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ReplicationDomainCfgClient,ReplicationDomainCfg>

Returns:

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

getAssuredSdLevelPropertyDefinition

public IntegerPropertyDefinition getAssuredSdLevelPropertyDefinition()

Get the "assured-sd-level" property definition.

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 "assured-sd-level" property definition.

getAssuredTimeoutPropertyDefinition

public DurationPropertyDefinition getAssuredTimeoutPropertyDefinition()

Get the "assured-timeout" property definition.

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 "assured-timeout" property definition.

getAssuredTypePropertyDefinition

public EnumPropertyDefinition<ReplicationDomainCfgDefn.AssuredType> getAssuredTypePropertyDefinition()

Get the "assured-type" property definition.

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 "assured-type" property definition.

getBaseDNPropertyDefinition

public DNPropertyDefinition getBaseDNPropertyDefinition()

Get the "base-dn" property definition.

Specifies the base DN of the replicated data.

Returns:

Returns the "base-dn" property definition.

getChangetimeHeartbeatIntervalPropertyDefinition

public DurationPropertyDefinition getChangetimeHeartbeatIntervalPropertyDefinition()

Get the "changetime-heartbeat-interval" property definition.

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 "changetime-heartbeat-interval" property definition.

getConflictsHistoricalPurgeDelayPropertyDefinition

public DurationPropertyDefinition getConflictsHistoricalPurgeDelayPropertyDefinition()

Get the "conflicts-historical-purge-delay" property definition.

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 "conflicts-historical-purge-delay" property definition.

getFractionalExcludePropertyDefinition

public StringPropertyDefinition getFractionalExcludePropertyDefinition()

Get the "fractional-exclude" property definition.

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 "fractional-exclude" property definition.

getFractionalIncludePropertyDefinition

public StringPropertyDefinition getFractionalIncludePropertyDefinition()

Get the "fractional-include" property definition.

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 "fractional-include" property definition.

getGroupIdPropertyDefinition

public IntegerPropertyDefinition getGroupIdPropertyDefinition()

Get the "group-id" property definition.

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 "group-id" property definition.

getHeartbeatIntervalPropertyDefinition

public DurationPropertyDefinition getHeartbeatIntervalPropertyDefinition()

Get the "heartbeat-interval" property definition.

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 "heartbeat-interval" property definition.

getInitializationWindowSizePropertyDefinition

public IntegerPropertyDefinition getInitializationWindowSizePropertyDefinition()

Get the "initialization-window-size" property definition.

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

Returns:

Returns the "initialization-window-size" property definition.

getIsolationPolicyPropertyDefinition

public EnumPropertyDefinition<ReplicationDomainCfgDefn.IsolationPolicy> getIsolationPolicyPropertyDefinition()

Get the "isolation-policy" property definition.

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 "isolation-policy" property definition.

getLogChangenumberPropertyDefinition

public BooleanPropertyDefinition getLogChangenumberPropertyDefinition()

Get the "log-changenumber" property definition.

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 "log-changenumber" property definition.

getReferralsUrlPropertyDefinition

public StringPropertyDefinition getReferralsUrlPropertyDefinition()

Get the "referrals-url" property definition.

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 "referrals-url" property definition.

getReplicationServerPropertyDefinition

public StringPropertyDefinition getReplicationServerPropertyDefinition()

Get the "replication-server" property definition.

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 "replication-server" property definition.

getServerIdPropertyDefinition

public IntegerPropertyDefinition getServerIdPropertyDefinition()

Get the "server-id" property definition.

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 "server-id" property definition.

getSolveConflictsPropertyDefinition

public BooleanPropertyDefinition getSolveConflictsPropertyDefinition()

Get the "solve-conflicts" property definition.

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

getWindowSizePropertyDefinition

public IntegerPropertyDefinition getWindowSizePropertyDefinition()

Get the "window-size" property definition.

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 "window-size" property definition.

getExternalChangelogDomainRelationDefinition

public SingletonRelationDefinition<ExternalChangelogDomainCfgClient,ExternalChangelogDomainCfg> getExternalChangelogDomainRelationDefinition()

Get the "external-changelog-domain" relation definition.

Returns:

Returns the "external-changelog-domain" relation definition.