public interface ReplicationSynchronizationProviderCfgClient extends SynchronizationProviderCfgClient
The Replication Synchronization Provider provides multi-master replication of data across multiple directory server instances.
Modifier and Type | Method and Description |
---|---|
<C extends ReplicationDomainCfgClient> |
createReplicationDomain(ManagedObjectDefinition<C,? extends ReplicationDomainCfg> d,
String name,
Collection<PropertyException> exceptions)
Creates a new Replication Domain.
|
<C extends ReplicationServerCfgClient> |
createReplicationServer(ManagedObjectDefinition<C,? extends ReplicationServerCfg> d,
Collection<PropertyException> exceptions)
Creates a new Replication Server.
|
ManagedObjectDefinition<? extends ReplicationSynchronizationProviderCfgClient,? extends ReplicationSynchronizationProviderCfg> |
definition()
Get the configuration definition associated with this Replication Synchronization Provider.
|
long |
getConnectionTimeout()
Gets the "connection-timeout" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
Integer |
getNumUpdateReplayThreads()
Gets the "num-update-replay-threads" property.
|
ReplicationDomainCfgClient |
getReplicationDomain(String name)
Gets the named Replication Domain.
|
ReplicationServerCfgClient |
getReplicationServer()
Gets the Replication Server if it is present.
|
boolean |
hasReplicationServer()
Determines whether the Replication Server exists.
|
String[] |
listReplicationDomains()
Lists the Replication Domains.
|
void |
removeReplicationDomain(String name)
Removes the named Replication Domain.
|
void |
removeReplicationServer()
Removes the Replication Server if it exists.
|
void |
setConnectionTimeout(Long value)
Sets the "connection-timeout" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
void |
setNumUpdateReplayThreads(Integer value)
Sets the "num-update-replay-threads" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends ReplicationSynchronizationProviderCfgClient,? extends ReplicationSynchronizationProviderCfg> definition()
definition
in interface ConfigurationClient
definition
in interface SynchronizationProviderCfgClient
long getConnectionTimeout()
Specifies the timeout used when connecting to peers and when performing SSL negotiation.
void setConnectionTimeout(Long value) throws PropertyException
Specifies the timeout used when connecting to peers and when performing SSL negotiation.
value
- The value of the "connection-timeout" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Replication Synchronization Provider implementation.
getJavaClass
in interface SynchronizationProviderCfgClient
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the Replication Synchronization Provider implementation.
setJavaClass
in interface SynchronizationProviderCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.Integer getNumUpdateReplayThreads()
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.
void setNumUpdateReplayThreads(Integer value) throws PropertyException
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.
value
- The value of the "num-update-replay-threads" property.PropertyException
- If the new value is invalid.String[] listReplicationDomains() throws ConcurrentModificationException, LdapException
ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.LdapException
- If any other error occurs.ReplicationDomainCfgClient getReplicationDomain(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
name
- The name of the Replication Domain to retrieve.DefinitionDecodingException
- If the named Replication Domain was found but its type
could not be determined.ManagedObjectDecodingException
- If the named Replication Domain was found but one or
more of its properties could not be decoded.ManagedObjectNotFoundException
- If the named Replication Domain was not found on the
server.ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.LdapException
- If any other error occurs.<C extends ReplicationDomainCfgClient> C createReplicationDomain(ManagedObjectDefinition<C,? extends ReplicationDomainCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.C
- The type of the Replication Domain being created.d
- The definition of the Replication Domain to be created.name
- The name of the new Replication Domain.exceptions
- An optional collection in which to place any PropertyException
s that occurred whilst attempting to
determine the default values of the Replication Domain.
This argument can be null.
IllegalManagedObjectNameException
- If the name of the new Replication Domain is invalid.void removeReplicationDomain(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
name
- The name of the Replication Domain to remove.ManagedObjectNotFoundException
- If the Replication Domain does not exist.OperationRejectedException
- If the server refuses to remove the Replication Domain
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.LdapException
- If any other error occurs.boolean hasReplicationServer() throws ConcurrentModificationException, LdapException
ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.LdapException
- If any other error occurs.ReplicationServerCfgClient getReplicationServer() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
DefinitionDecodingException
- If the Replication Server was found but its type could
not be determined.ManagedObjectDecodingException
- If the Replication Server was found but one or more of
its properties could not be decoded.ManagedObjectNotFoundException
- If the Replication Server is not present.ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.LdapException
- If any other error occurs.<C extends ReplicationServerCfgClient> C createReplicationServer(ManagedObjectDefinition<C,? extends ReplicationServerCfg> d, Collection<PropertyException> exceptions)
ConfigurationClient.commit()
method.C
- The type of the Replication Server being created.d
- The definition of the Replication Server to be created.exceptions
- An optional collection in which to place any PropertyException
s that occurred whilst attempting to
determine the default values of the Replication Server.
This argument can be null.
void removeReplicationServer() throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
ManagedObjectNotFoundException
- If the Replication Server does not exist.OperationRejectedException
- If the server refuses to remove the Replication Server
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.LdapException
- If any other error occurs.Copyright 2010-2020 ForgeRock AS.