org.opends.server.admin.std.server
Interface ReplicationSynchronizationProviderCfg

All Superinterfaces:
Configuration, SynchronizationProviderCfg

public interface ReplicationSynchronizationProviderCfg
extends SynchronizationProviderCfg

A server-side interface for querying Replication Synchronization Provider settings.

The Replication Synchronization Provider provides multi-master replication of data across multiple Directory Server instances.


Method Summary
 void addReplicationChangeListener(ConfigurationChangeListener<ReplicationSynchronizationProviderCfg> listener)
          Register to be notified when this Replication Synchronization Provider is changed.
 void addReplicationDomainAddListener(ConfigurationAddListener<ReplicationDomainCfg> listener)
          Registers to be notified when new Replication Domains are added.
 void addReplicationDomainDeleteListener(ConfigurationDeleteListener<ReplicationDomainCfg> listener)
          Registers to be notified when existing Replication Domains are deleted.
 void addReplicationServerAddListener(ConfigurationAddListener<ReplicationServerCfg> listener)
          Registers to be notified when the Replication Server is added.
 void addReplicationServerDeleteListener(ConfigurationDeleteListener<ReplicationServerCfg> listener)
          Registers to be notified the Replication Server is deleted.
 java.lang.Class<? extends ReplicationSynchronizationProviderCfg> configurationClass()
          Gets the configuration class associated with this Replication Synchronization Provider.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 int getNumUpdateReplayThreads()
          Gets the "num-update-replay-threads" property.
 ReplicationDomainCfg getReplicationDomain(java.lang.String name)
          Gets the named Replication Domain.
 ReplicationServerCfg getReplicationServer()
          Gets the Replication Server if it is present.
 boolean hasReplicationServer()
          Determines whether or not the Replication Server exists.
 java.lang.String[] listReplicationDomains()
          Lists the Replication Domains.
 void removeReplicationChangeListener(ConfigurationChangeListener<ReplicationSynchronizationProviderCfg> listener)
          Deregister an existing Replication Synchronization Provider configuration change listener.
 void removeReplicationDomainAddListener(ConfigurationAddListener<ReplicationDomainCfg> listener)
          Deregisters an existing Replication Domain configuration add listener.
 void removeReplicationDomainDeleteListener(ConfigurationDeleteListener<ReplicationDomainCfg> listener)
          Deregisters an existing Replication Domain configuration delete listener.
 void removeReplicationServerAddListener(ConfigurationAddListener<ReplicationServerCfg> listener)
          Deregisters an existing Replication Server configuration add listener.
 void removeReplicationServerDeleteListener(ConfigurationDeleteListener<ReplicationServerCfg> listener)
          Deregisters an existing Replication Server configuration delete listener.
 
Methods inherited from interface org.opends.server.admin.std.server.SynchronizationProviderCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends ReplicationSynchronizationProviderCfg> configurationClass()
Gets the configuration class associated with this Replication Synchronization Provider.

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

addReplicationChangeListener

void addReplicationChangeListener(ConfigurationChangeListener<ReplicationSynchronizationProviderCfg> listener)
Register to be notified when this Replication Synchronization Provider is changed.

Parameters:
listener - The Replication Synchronization Provider configuration change listener.

removeReplicationChangeListener

void removeReplicationChangeListener(ConfigurationChangeListener<ReplicationSynchronizationProviderCfg> listener)
Deregister an existing Replication Synchronization Provider configuration change listener.

Parameters:
listener - The Replication Synchronization Provider configuration change listener.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Replication Synchronization Provider implementation.

Specified by:
getJavaClass in interface SynchronizationProviderCfg
Returns:
Returns the value of the "java-class" property.

getNumUpdateReplayThreads

int getNumUpdateReplayThreads()
Gets the "num-update-replay-threads" property.

Specifies the number of update replay threads.

This value is the number of threads created for replaying every updates received for all the replication domains.

Returns:
Returns the value of the "num-update-replay-threads" property.

listReplicationDomains

java.lang.String[] listReplicationDomains()
Lists the Replication Domains.

Returns:
Returns an array containing the names of the Replication Domains.

getReplicationDomain

ReplicationDomainCfg getReplicationDomain(java.lang.String name)
                                          throws ConfigException
Gets the named Replication Domain.

Parameters:
name - The name of the Replication Domain to retrieve.
Returns:
Returns the named Replication Domain.
Throws:
ConfigException - If the Replication Domain could not be found or it could not be successfully decoded.

addReplicationDomainAddListener

void addReplicationDomainAddListener(ConfigurationAddListener<ReplicationDomainCfg> listener)
                                     throws ConfigException
Registers to be notified when new Replication Domains are added.

Parameters:
listener - The Replication Domain configuration add listener.
Throws:
ConfigException - If the add listener could not be registered.

removeReplicationDomainAddListener

void removeReplicationDomainAddListener(ConfigurationAddListener<ReplicationDomainCfg> listener)
Deregisters an existing Replication Domain configuration add listener.

Parameters:
listener - The Replication Domain configuration add listener.

addReplicationDomainDeleteListener

void addReplicationDomainDeleteListener(ConfigurationDeleteListener<ReplicationDomainCfg> listener)
                                        throws ConfigException
Registers to be notified when existing Replication Domains are deleted.

Parameters:
listener - The Replication Domain configuration delete listener.
Throws:
ConfigException - If the delete listener could not be registered.

removeReplicationDomainDeleteListener

void removeReplicationDomainDeleteListener(ConfigurationDeleteListener<ReplicationDomainCfg> listener)
Deregisters an existing Replication Domain configuration delete listener.

Parameters:
listener - The Replication Domain configuration delete listener.

hasReplicationServer

boolean hasReplicationServer()
Determines whether or not the Replication Server exists.

Returns:
Returns if the Replication Server exists.

getReplicationServer

ReplicationServerCfg getReplicationServer()
                                          throws ConfigException
Gets the Replication Server if it is present.

Returns:
Returns the Replication Server if it is present.
Throws:
ConfigException - If the Replication Server does not exist or it could not be successfully decoded.

addReplicationServerAddListener

void addReplicationServerAddListener(ConfigurationAddListener<ReplicationServerCfg> listener)
                                     throws ConfigException
Registers to be notified when the Replication Server is added.

Parameters:
listener - The Replication Server configuration add listener.
Throws:
ConfigException - If the add listener could not be registered.

removeReplicationServerAddListener

void removeReplicationServerAddListener(ConfigurationAddListener<ReplicationServerCfg> listener)
Deregisters an existing Replication Server configuration add listener.

Parameters:
listener - The Replication Server configuration add listener.

addReplicationServerDeleteListener

void addReplicationServerDeleteListener(ConfigurationDeleteListener<ReplicationServerCfg> listener)
                                        throws ConfigException
Registers to be notified the Replication Server is deleted.

Parameters:
listener - The Replication Server configuration delete listener.
Throws:
ConfigException - If the delete listener could not be registered.

removeReplicationServerDeleteListener

void removeReplicationServerDeleteListener(ConfigurationDeleteListener<ReplicationServerCfg> listener)
Deregisters an existing Replication Server configuration delete listener.

Parameters:
listener - The Replication Server configuration delete listener.