org.opends.server.admin.std.client
Interface ReplicationDomainCfgClient

All Superinterfaces:
ConfigurationClient

public interface ReplicationDomainCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Replication Domain settings.

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


Method Summary
 ManagedObjectDefinition<? extends ReplicationDomainCfgClient,? extends ReplicationDomainCfg> definition()
          Get the configuration definition 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.
 java.lang.Integer getServerId()
          Gets the "server-id" property.
 int getWindowSize()
          Gets the "window-size" property.
 void setBaseDN(DN value)
          Sets the "base-dn" property.
 void setHeartbeatInterval(java.lang.Long value)
          Sets the "heartbeat-interval" property.
 void setIsolationPolicy(ReplicationDomainCfgDefn.IsolationPolicy value)
          Sets the "isolation-policy" property.
 void setReplicationServer(java.util.Collection<java.lang.String> values)
          Sets the "replication-server" property.
 void setServerId(int value)
          Sets the "server-id" property.
 void setWindowSize(java.lang.Integer value)
          Sets the "window-size" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends ReplicationDomainCfgClient,? extends ReplicationDomainCfg> definition()
Get the configuration definition associated with this Replication Domain.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Replication Domain.

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.

setBaseDN

void setBaseDN(DN value)
               throws IllegalPropertyValueException,
                      PropertyIsReadOnlyException
Sets the "base-dn" property.

Specifies the base DN of the replicated data.

This property is read-only and can only be modified during creation of a Replication Domain.

Parameters:
value - The value of the "base-dn" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Replication Domain is not being initialized.

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.

setHeartbeatInterval

void setHeartbeatInterval(java.lang.Long value)
                          throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "heartbeat-interval" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setIsolationPolicy

void setIsolationPolicy(ReplicationDomainCfgDefn.IsolationPolicy value)
                        throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "isolation-policy" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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

setReplicationServer

void setReplicationServer(java.util.Collection<java.lang.String> values)
                          throws IllegalPropertyValueException
Sets 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

Parameters:
values - The values of the "replication-server" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

getServerId

java.lang.Integer 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.

setServerId

void setServerId(int value)
                 throws IllegalPropertyValueException,
                        PropertyIsReadOnlyException
Sets 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.

This property is read-only and can only be modified during creation of a Replication Domain.

Parameters:
value - The value of the "server-id" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Replication Domain is not being initialized.

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.

setWindowSize

void setWindowSize(java.lang.Integer value)
                   throws IllegalPropertyValueException
Sets the "window-size" property.

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

Parameters:
value - The value of the "window-size" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.