org.forgerock.opendj.server.config.server

Interface ReplicationServiceDiscoveryMechanismCfg

All Superinterfaces:

Configuration, ServiceDiscoveryMechanismCfg

public interface ReplicationServiceDiscoveryMechanismCfg
extends ServiceDiscoveryMechanismCfg

A server-side interface for querying Replication Service Discovery Mechanism settings.

A Replication Service Discovery Mechanism returns the set of directory servers participating in a replication topology.

Method Summary

Modifier and Type	Method and Description
void	addReplicationChangeListener(ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg> listener) Register to be notified when this Replication Service Discovery Mechanism is changed.
Class<? extends ReplicationServiceDiscoveryMechanismCfg>	configurationClass() Gets the configuration class associated with this Replication Service Discovery Mechanism.
org.forgerock.opendj.ldap.DN	getBindDN() Gets the "bind-dn" property.
String	getBindPassword() Gets the "bind-password" property.
long	getDiscoveryInterval() Gets the "discovery-interval" property.
String	getJavaClass() Gets the "java-class" property.
Integer	getPrimaryGroupId() Gets the "primary-group-id" property.
SortedSet<String>	getReplicationServer() Gets the "replication-server" property.
void	removeReplicationChangeListener(ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg> listener) Deregister an existing Replication Service Discovery Mechanism configuration change listener.

Methods inherited from interface org.forgerock.opendj.server.config.server.ServiceDiscoveryMechanismCfg

addChangeListener, getKeyManagerProvider, getKeyManagerProviderDN, getSSLCertNickname, getTrustManagerProvider, getTrustManagerProviderDN, isUseSSL, isUseStartTLS, removeChangeListener

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Method Detail

configurationClass

Class<? extends ReplicationServiceDiscoveryMechanismCfg> configurationClass()

Gets the configuration class associated with this Replication Service Discovery Mechanism.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface ServiceDiscoveryMechanismCfg

Returns:

Returns the configuration class associated with this Replication Service Discovery Mechanism.

addReplicationChangeListener

void addReplicationChangeListener(ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg> listener)

Register to be notified when this Replication Service Discovery Mechanism is changed.

Parameters:

listener - The Replication Service Discovery Mechanism configuration change listener.

removeReplicationChangeListener

void removeReplicationChangeListener(ConfigurationChangeListener<ReplicationServiceDiscoveryMechanismCfg> listener)

Deregister an existing Replication Service Discovery Mechanism configuration change listener.

Parameters:

listener - The Replication Service Discovery Mechanism configuration change listener.

getBindDN

org.forgerock.opendj.ldap.DN getBindDN()

Gets the "bind-dn" property.

The bind DN for periodically reading replication server configurations

The bind DN must be present on all replication servers and directory servers, it must be able to read the server configuration.

Returns:

Returns the value of the "bind-dn" property.

getBindPassword

String getBindPassword()

Gets the "bind-password" property.

The bind password for periodically reading replication server configurations

The bind password must be the same on all replication and directory servers

Returns:

Returns the value of the "bind-password" property.

getDiscoveryInterval

long getDiscoveryInterval()

Gets the "discovery-interval" property.

Interval between two replication server configuration discovery queries.

Specifies how frequently to query a replication server configuration in order to discover information about available directory server replicas.

Returns:

Returns the value of the "discovery-interval" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Replication Service Discovery Mechanism implementation.

Specified by:

getJavaClass in interface ServiceDiscoveryMechanismCfg

Returns:

Returns the value of the "java-class" property.

getPrimaryGroupId

Integer getPrimaryGroupId()

Gets the "primary-group-id" property.

Replication domain group ID of preferred directory server replicas.

Directory server replicas with this replication domain group ID will be preferred over other directory server replicas. Secondary server replicas will only be used when all primary server replicas become unavailable.

Returns:

Returns the value of the "primary-group-id" property.

getReplicationServer

SortedSet<String> getReplicationServer()

Gets the "replication-server" property.

Specifies the list of replication servers to contact periodically when discovering server replicas.

Returns:

Returns an unmodifiable set containing the values of the "replication-server" property.