public interface ReplicationServiceDiscoveryMechanismCfgClient extends ServiceDiscoveryMechanismCfgClient
A Replication Service Discovery Mechanism returns the set of directory servers participating in a replication topology.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends ReplicationServiceDiscoveryMechanismCfgClient,? extends ReplicationServiceDiscoveryMechanismCfg> |
definition()
Get the configuration definition associated with this Replication Service Discovery Mechanism.
|
Dn |
getBindDn()
Gets the "bind-dn" property.
|
String |
getBindPassword()
Gets the "bind-password" property.
|
String |
getBindPasswordEnvironmentVariable()
Gets the "bind-password-environment-variable" property.
|
String |
getBindPasswordFile()
Gets the "bind-password-file" property.
|
String |
getBindPasswordProperty()
Gets the "bind-password-property" property.
|
long |
getDiscoveryInterval()
Gets the "discovery-interval" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getKeyManagerProvider()
Gets the "key-manager-provider" property.
|
Integer |
getPrimaryGroupId()
Gets the "primary-group-id" property.
|
SortedSet<String> |
getReplicationServer()
Gets the "replication-server" property.
|
SortedSet<String> |
getSslCertNickname()
Gets the "ssl-cert-nickname" property.
|
String |
getTrustManagerProvider()
Gets the "trust-manager-provider" property.
|
boolean |
isUseSsl()
Gets the "use-ssl" property.
|
boolean |
isUseStartTls()
Gets the "use-start-tls" property.
|
void |
setBindDn(Dn value)
Sets the "bind-dn" property.
|
void |
setBindPassword(String value)
Sets the "bind-password" property.
|
void |
setBindPasswordEnvironmentVariable(String value)
Sets the "bind-password-environment-variable" property.
|
void |
setBindPasswordFile(String value)
Sets the "bind-password-file" property.
|
void |
setBindPasswordProperty(String value)
Sets the "bind-password-property" property.
|
void |
setDiscoveryInterval(Long value)
Sets the "discovery-interval" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
void |
setKeyManagerProvider(String value)
Sets the "key-manager-provider" property.
|
void |
setPrimaryGroupId(Integer value)
Sets the "primary-group-id" property.
|
void |
setReplicationServer(Collection<String> values)
Sets the "replication-server" property.
|
void |
setSslCertNickname(Collection<String> values)
Sets the "ssl-cert-nickname" property.
|
void |
setTrustManagerProvider(String value)
Sets the "trust-manager-provider" property.
|
void |
setUseSsl(Boolean value)
Sets the "use-ssl" property.
|
void |
setUseStartTls(Boolean value)
Sets the "use-start-tls" property.
|
commit, properties
ManagedObjectDefinition<? extends ReplicationServiceDiscoveryMechanismCfgClient,? extends ReplicationServiceDiscoveryMechanismCfg> definition()
definition
in interface ConfigurationClient
definition
in interface ServiceDiscoveryMechanismCfgClient
Dn getBindDn()
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.
void setBindDn(Dn value) throws PropertyException
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.
value
- The value of the "bind-dn" property.PropertyException
- If the new value is invalid.String getBindPassword()
The clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
void setBindPassword(String value) throws PropertyException
The clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
value
- The value of the "bind-password" property.PropertyException
- If the new value is invalid.String getBindPasswordEnvironmentVariable()
Specifies the name of the environment variable that contains the clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
void setBindPasswordEnvironmentVariable(String value) throws PropertyException
Specifies the name of the environment variable that contains the clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
value
- The value of the "bind-password-environment-variable" property.PropertyException
- If the new value is invalid.String getBindPasswordFile()
Specifies the path to the text file whose only contents should be a single line containing the clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
void setBindPasswordFile(String value) throws PropertyException
Specifies the path to the text file whose only contents should be a single line containing the clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
value
- The value of the "bind-password-file" property.PropertyException
- If the new value is invalid.String getBindPasswordProperty()
Specifies the name of the Java property that contains the clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
void setBindPasswordProperty(String value) throws PropertyException
Specifies the name of the Java property that contains the clear-text bind password for periodically reading replication server configurations.
The bind password must be the same on all replication and directory servers.
value
- The value of the "bind-password-property" property.PropertyException
- If the new value is invalid.long getDiscoveryInterval()
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.
void setDiscoveryInterval(Long value) throws PropertyException
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.
value
- The value of the "discovery-interval" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Replication Service Discovery Mechanism implementation.
getJavaClass
in interface ServiceDiscoveryMechanismCfgClient
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the Replication Service Discovery Mechanism implementation.
setJavaClass
in interface ServiceDiscoveryMechanismCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.String getKeyManagerProvider()
Specifies the name of the key manager that should be used with this Replication Service Discovery Mechanism.
void setKeyManagerProvider(String value) throws PropertyException
Specifies the name of the key manager that should be used with this Replication Service Discovery Mechanism.
value
- The value of the "key-manager-provider" property.PropertyException
- If the new value is invalid.Integer getPrimaryGroupId()
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.
void setPrimaryGroupId(Integer value) throws PropertyException
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.
value
- The value of the "primary-group-id" property.PropertyException
- If the new value is invalid.SortedSet<String> getReplicationServer()
Specifies the list of replication servers to contact periodically when discovering server replicas.
Since the replication servers will be contacted to perform this administrative task, the administration port should be used to ensure timely responses in all circumstances.
void setReplicationServer(Collection<String> values) throws PropertyException
Specifies the list of replication servers to contact periodically when discovering server replicas.
Since the replication servers will be contacted to perform this administrative task, the administration port should be used to ensure timely responses in all circumstances.
values
- The values of the "replication-server" property.PropertyException
- If one or more of the new values are invalid.SortedSet<String> getSslCertNickname()
Specifies the nicknames (also called the aliases) of the keys or key pairs that the Replication Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
This is only applicable when the Replication Service Discovery Mechanism is configured to use SSL.
void setSslCertNickname(Collection<String> values) throws PropertyException
Specifies the nicknames (also called the aliases) of the keys or key pairs that the Replication Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
This is only applicable when the Replication Service Discovery Mechanism is configured to use SSL.
values
- The values of the "ssl-cert-nickname" property.PropertyException
- If one or more of the new values are invalid.String getTrustManagerProvider()
Specifies the name of the trust manager that should be used with the Replication Service Discovery Mechanism.
void setTrustManagerProvider(String value) throws PropertyException
Specifies the name of the trust manager that should be used with the Replication Service Discovery Mechanism.
value
- The value of the "trust-manager-provider" property.PropertyException
- If the new value is invalid.boolean isUseSsl()
Indicates whether the Replication Service Discovery Mechanism should use SSL.
If enabled, the Replication Service Discovery Mechanism will use SSL to encrypt communication with the clients.
void setUseSsl(Boolean value) throws PropertyException
Indicates whether the Replication Service Discovery Mechanism should use SSL.
If enabled, the Replication Service Discovery Mechanism will use SSL to encrypt communication with the clients.
value
- The value of the "use-ssl" property.PropertyException
- If the new value is invalid.boolean isUseStartTls()
Indicates whether the Replication Service Discovery Mechanism should use Start TLS.
If enabled, the Replication Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.
void setUseStartTls(Boolean value) throws PropertyException
Indicates whether the Replication Service Discovery Mechanism should use Start TLS.
If enabled, the Replication Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.
value
- The value of the "use-start-tls" property.PropertyException
- If the new value is invalid.Copyright 2010-2020 ForgeRock AS.