Package org.forgerock.opendj.server.config.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 Detail

      • 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.

      • getConnectionTimeout

        long getConnectionTimeout()
        Gets the "connection-timeout" property.

        Specifies the timeout used when connecting to peers and when performing SSL negotiation.

        Returns:
        Returns the value of the "connection-timeout" property.

      • getJavaClass

        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

        Integer 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

        String[] listReplicationDomains()
        Lists the Replication Domains.
        Returns:
        Returns an array containing the names of the Replication Domains.

      • getReplicationDomain

        ReplicationDomainCfg getReplicationDomain​(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.

      • 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 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.

      • removeReplicationServerAddListener

        void removeReplicationServerAddListener​(ConfigurationAddListener<ReplicationServerCfg> listener)
        Deregisters an existing Replication Server configuration add listener.
        Parameters:
        listener - The Replication Server configuration add listener.

      • removeReplicationServerDeleteListener

        void removeReplicationServerDeleteListener​(ConfigurationDeleteListener<ReplicationServerCfg> listener)
        Deregisters an existing Replication Server configuration delete listener.
        Parameters:
        listener - The Replication Server configuration delete listener.