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

All Superinterfaces:
ConfigurationClient

public interface ReplicationServerCfgClient
extends ConfigurationClient

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

Replication Servers publish updates to Directory Servers within a Replication Domain.


Method Summary
 ManagedObjectDefinition<? extends ReplicationServerCfgClient,? extends ReplicationServerCfg> definition()
          Get the configuration definition associated with this Replication Server.
 int getQueueSize()
          Gets the "queue-size" property.
 java.lang.String getReplicationDBDirectory()
          Gets the "replication-db-directory" property.
 java.lang.Integer getReplicationPort()
          Gets the "replication-port" property.
 long getReplicationPurgeDelay()
          Gets the "replication-purge-delay" property.
 java.util.SortedSet<java.lang.String> getReplicationServer()
          Gets the "replication-server" property.
 java.lang.Integer getReplicationServerId()
          Gets the "replication-server-id" property.
 int getWindowSize()
          Gets the "window-size" property.
 void setQueueSize(java.lang.Integer value)
          Sets the "queue-size" property.
 void setReplicationDBDirectory(java.lang.String value)
          Sets the "replication-db-directory" property.
 void setReplicationPort(int value)
          Sets the "replication-port" property.
 void setReplicationPurgeDelay(java.lang.Long value)
          Sets the "replication-purge-delay" property.
 void setReplicationServer(java.util.Collection<java.lang.String> values)
          Sets the "replication-server" property.
 void setReplicationServerId(int value)
          Sets the "replication-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 ReplicationServerCfgClient,? extends ReplicationServerCfg> definition()
Get the configuration definition associated with this Replication Server.

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

getQueueSize

int getQueueSize()
Gets the "queue-size" property.

Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain.

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

setQueueSize

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

Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain.

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

getReplicationDBDirectory

java.lang.String getReplicationDBDirectory()
Gets the "replication-db-directory" property.

The path where the Replication Server stores all persistent information.

Returns:
Returns the value of the "replication-db-directory" property.

setReplicationDBDirectory

void setReplicationDBDirectory(java.lang.String value)
                               throws IllegalPropertyValueException,
                                      PropertyIsReadOnlyException
Sets the "replication-db-directory" property.

The path where the Replication Server stores all persistent information.

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

Parameters:
value - The value of the "replication-db-directory" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Replication Server is not being initialized.

getReplicationPort

java.lang.Integer getReplicationPort()
Gets the "replication-port" property.

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.

Returns:
Returns the value of the "replication-port" property.

setReplicationPort

void setReplicationPort(int value)
                        throws IllegalPropertyValueException
Sets the "replication-port" property.

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.

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

getReplicationPurgeDelay

long getReplicationPurgeDelay()
Gets the "replication-purge-delay" property.

The time (in seconds) after which the Replication Server erases all persistent information.

Returns:
Returns the value of the "replication-purge-delay" property.

setReplicationPurgeDelay

void setReplicationPurgeDelay(java.lang.Long value)
                              throws IllegalPropertyValueException
Sets the "replication-purge-delay" property.

The time (in seconds) after which the Replication Server erases all persistent information.

Parameters:
value - The value of the "replication-purge-delay" 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 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 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 other Replication Servers to which this Replication Server tries 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.

getReplicationServerId

java.lang.Integer getReplicationServerId()
Gets the "replication-server-id" property.

Specifies a unique identifier for the Replication Server.

Each Replication Server must have a different server ID.

Returns:
Returns the value of the "replication-server-id" property.

setReplicationServerId

void setReplicationServerId(int value)
                            throws IllegalPropertyValueException,
                                   PropertyIsReadOnlyException
Sets the "replication-server-id" property.

Specifies a unique identifier for the Replication Server.

Each Replication Server must have a different server ID.

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

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

getWindowSize

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

Specifies the window size that the Replication Server uses when communicating with other 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 Replication Server uses when communicating with other Replication Servers.

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