org.opends.server.admin.std.server
Interface ReplicationDomainCfg

All Superinterfaces:
Configuration

public interface ReplicationDomainCfg
extends Configuration

A server-side interface for querying Replication Domain settings.

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


Method Summary
 void addChangeListener(ConfigurationChangeListener<ReplicationDomainCfg> listener)
          Register to be notified when this Replication Domain is changed.
 java.lang.Class<? extends ReplicationDomainCfg> configurationClass()
          Gets the configuration class associated with this Replication Domain.
 DN getBaseDN()
          Gets the "base-dn" property.
 long getHeartbeatInterval()
          Gets the "heartbeat-interval" property.
 ReplicationDomainCfgDefn.IsolationPolicy getIsolationPolicy()
          Gets the "isolation-policy" property.
 java.util.SortedSet<java.lang.String> getReplicationServer()
          Gets the "replication-server" property.
 int getServerId()
          Gets the "server-id" property.
 int getWindowSize()
          Gets the "window-size" property.
 void removeChangeListener(ConfigurationChangeListener<ReplicationDomainCfg> listener)
          Deregister an existing Replication Domain configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends ReplicationDomainCfg> configurationClass()
Gets the configuration class associated with this Replication Domain.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Replication Domain.

addChangeListener

void addChangeListener(ConfigurationChangeListener<ReplicationDomainCfg> listener)
Register to be notified when this Replication Domain is changed.

Parameters:
listener - The Replication Domain configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<ReplicationDomainCfg> listener)
Deregister an existing Replication Domain configuration change listener.

Parameters:
listener - The Replication Domain configuration change listener.

getBaseDN

DN getBaseDN()
Gets the "base-dn" property.

Specifies the base DN of the replicated data.

Returns:
Returns the value of the "base-dn" property.

getHeartbeatInterval

long getHeartbeatInterval()
Gets the "heartbeat-interval" property.

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 value of the "heartbeat-interval" property.

getIsolationPolicy

ReplicationDomainCfgDefn.IsolationPolicy getIsolationPolicy()
Gets the "isolation-policy" property.

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 value of the "isolation-policy" property.

getReplicationServer

java.util.SortedSet<java.lang.String> getReplicationServer()
Gets the "replication-server" property.

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 an unmodifiable set containing the values of the "replication-server" property.

getServerId

int getServerId()
Gets the "server-id" property.

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 value of the "server-id" property.

getWindowSize

int getWindowSize()
Gets the "window-size" property.

Specifies the window size that the Directory Server will use when communicating with Replication Servers.

Returns:
Returns the value of the "window-size" property.