Package org.forgerock.opendj.server.config.client

Interface ReplicationServiceDiscoveryMechanismCfgClient

All Superinterfaces:

ConfigurationClient, ServiceDiscoveryMechanismCfgClient

public interface ReplicationServiceDiscoveryMechanismCfgClient
extends ServiceDiscoveryMechanismCfgClient

A client-side interface for reading and modifying 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	Description
ManagedObjectDefinition<? extends ReplicationServiceDiscoveryMechanismCfgClient,? extends ReplicationServiceDiscoveryMechanismCfg>	definition()	Get the configuration definition 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	setBindDN(org.forgerock.opendj.ldap.DN value)	Sets the "bind-dn" property.
void	setBindPassword(String value)	Sets the "bind-password" property.
void	setDiscoveryInterval(Long value)	Sets the "discovery-interval" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setPrimaryGroupId(Integer value)	Sets the "primary-group-id" property.
void	setReplicationServer(Collection<String> values)	Sets the "replication-server" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.ServiceDiscoveryMechanismCfgClient

getKeyManagerProvider, getSSLCertNickname, getTrustManagerProvider, isUseSSL, isUseStartTLS, setKeyManagerProvider, setSSLCertNickname, setTrustManagerProvider, setUseSSL, setUseStartTLS

Method Detail

definition

ManagedObjectDefinition<? extends ReplicationServiceDiscoveryMechanismCfgClient,? extends ReplicationServiceDiscoveryMechanismCfg> definition()

Get the configuration definition associated with this Replication Service Discovery Mechanism.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ServiceDiscoveryMechanismCfgClient

Returns:

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

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.

setBindDN

void setBindDN(org.forgerock.opendj.ldap.DN value)
        throws PropertyException

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setBindPassword

void setBindPassword(String value)
              throws PropertyException

Sets 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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setDiscoveryInterval

void setDiscoveryInterval(Long value)
                   throws PropertyException

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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 ServiceDiscoveryMechanismCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface ServiceDiscoveryMechanismCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setPrimaryGroupId

void setPrimaryGroupId(Integer value)
                throws PropertyException

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getReplicationServer

SortedSet<String> getReplicationServer()

Gets the "replication-server" property.

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

Returns:

Returns the values of the "replication-server" property.

setReplicationServer

void setReplicationServer(Collection<String> values)
                   throws PropertyException

Sets the "replication-server" property.

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

Parameters:

values - The values of the "replication-server" property.

Throws:

PropertyException - If one or more of the new values are invalid.