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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<ReplicationServerCfgClient,ReplicationServerCfg>
          extended by org.opends.server.admin.std.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
 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.
static ReplicationServerCfgDefn getInstance()
          Get the Replication Server configuration definition singleton.
 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.
 java.lang.Class<ReplicationServerCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object 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 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 java.lang.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.

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

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.

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.

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