org.opends.server.admin.std.meta
Class ReplicationDomainCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<ReplicationDomainCfgClient,ReplicationDomainCfg>
          extended by org.opends.server.admin.std.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
static class ReplicationDomainCfgDefn.IsolationPolicy
          Defines the set of permissable values for the "isolation-policy" property.
 
Method Summary
 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.
 DNPropertyDefinition getBaseDNPropertyDefinition()
          Get the "base-dn" property definition.
 DurationPropertyDefinition getHeartbeatIntervalPropertyDefinition()
          Get the "heartbeat-interval" property definition.
static ReplicationDomainCfgDefn getInstance()
          Get the Replication Domain configuration definition singleton.
 EnumPropertyDefinition<ReplicationDomainCfgDefn.IsolationPolicy> getIsolationPolicyPropertyDefinition()
          Get the "isolation-policy" property definition.
 StringPropertyDefinition getReplicationServerPropertyDefinition()
          Get the "replication-server" property definition.
 java.lang.Class<ReplicationDomainCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 IntegerPropertyDefinition getServerIdPropertyDefinition()
          Get the "server-id" property definition.
 IntegerPropertyDefinition getWindowSizePropertyDefinition()
          Get the "window-size" property definition.
 
Methods inherited from class org.opends.server.admin.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 java.lang.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.

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.

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.

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.

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.

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.

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