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

Interface ReplicationSynchronizationProviderCfgClient

All Superinterfaces:

ConfigurationClient, SynchronizationProviderCfgClient

public interface ReplicationSynchronizationProviderCfgClient
extends SynchronizationProviderCfgClient

A client-side interface for reading and modifying Replication Synchronization Provider settings.

The Replication Synchronization Provider provides multi-master replication of data across multiple directory server instances.

Method Summary

Modifier and Type	Method	Description
<C extends ReplicationDomainCfgClient> C	createReplicationDomain(ManagedObjectDefinition<C,? extends ReplicationDomainCfg> d, String name, Collection<PropertyException> exceptions)	Creates a new Replication Domain.
<C extends ReplicationServerCfgClient> C	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.

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

commit, properties

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

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends ReplicationSynchronizationProviderCfgClient,? extends ReplicationSynchronizationProviderCfg> definition()

Get the configuration definition associated with this Replication Synchronization Provider.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface SynchronizationProviderCfgClient

Returns:

Returns the configuration definition associated with this Replication Synchronization Provider.

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.

setConnectionTimeout

void setConnectionTimeout(Long value)
                   throws PropertyException

Sets the "connection-timeout" property.

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

Parameters:

value - The value of the "connection-timeout" 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 Synchronization Provider implementation.

Specified by:

getJavaClass in interface SynchronizationProviderCfgClient

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 Synchronization Provider implementation.

Specified by:

setJavaClass in interface SynchronizationProviderCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setNumUpdateReplayThreads

void setNumUpdateReplayThreads(Integer value)
                        throws PropertyException

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

Parameters:

value - The value of the "num-update-replay-threads" property.

Throws:

PropertyException - If the new value is invalid.

listReplicationDomains

String[] listReplicationDomains()
                         throws ConcurrentModificationException,
                                org.forgerock.opendj.ldap.LdapException

Lists the Replication Domains.

Returns:

Returns an array containing the names of the Replication Domains.

Throws:

ConcurrentModificationException - If this Replication Synchronization Provider has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getReplicationDomain

ReplicationDomainCfgClient getReplicationDomain(String name)
                                         throws DefinitionDecodingException,
                                                ManagedObjectDecodingException,
                                                ManagedObjectNotFoundException,
                                                ConcurrentModificationException,
                                                org.forgerock.opendj.ldap.LdapException

Gets the named Replication Domain.

Parameters:

name - The name of the Replication Domain to retrieve.

Returns:

Returns the named Replication Domain.

Throws:

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.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

createReplicationDomain

<C extends ReplicationDomainCfgClient> C createReplicationDomain(ManagedObjectDefinition<C,? extends ReplicationDomainCfg> d,
                                                                 String name,
                                                                 Collection<PropertyException> exceptions)
                                                          throws IllegalManagedObjectNameException

Creates a new Replication Domain. The new Replication Domain will initially not contain any property values (including mandatory properties). Once the Replication Domain has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Replication Domain being created.

Parameters:

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 PropertyExceptions that occurred whilst attempting to determine the default values of the Replication Domain. This argument can be null.

Returns:

Returns a new Replication Domain configuration instance.

Throws:

IllegalManagedObjectNameException - If the name of the new Replication Domain is invalid.

removeReplicationDomain

void removeReplicationDomain(String name)
                      throws ManagedObjectNotFoundException,
                             OperationRejectedException,
                             ConcurrentModificationException,
                             org.forgerock.opendj.ldap.LdapException

Removes the named Replication Domain.

Parameters:

name - The name of the Replication Domain to remove.

Throws:

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.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

hasReplicationServer

boolean hasReplicationServer()
                      throws ConcurrentModificationException,
                             org.forgerock.opendj.ldap.LdapException

Determines whether the Replication Server exists.

Returns:

Returns if the Replication Server exists.

Throws:

ConcurrentModificationException - If this Replication Synchronization Provider has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getReplicationServer

ReplicationServerCfgClient getReplicationServer()
                                         throws DefinitionDecodingException,
                                                ManagedObjectDecodingException,
                                                ManagedObjectNotFoundException,
                                                ConcurrentModificationException,
                                                org.forgerock.opendj.ldap.LdapException

Gets the Replication Server if it is present.

Returns:

Returns the Replication Server if it is present.

Throws:

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.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

createReplicationServer

<C extends ReplicationServerCfgClient> C createReplicationServer(ManagedObjectDefinition<C,? extends ReplicationServerCfg> d,
                                                                 Collection<PropertyException> exceptions)

Creates a new Replication Server. The new Replication Server will initially not contain any property values (including mandatory properties). Once the Replication Server has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Replication Server being created.

Parameters:

d - The definition of the Replication Server to be created.

exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Replication Server. This argument can be null.

Returns:

Returns a new Replication Server configuration instance.

removeReplicationServer

void removeReplicationServer()
                      throws ManagedObjectNotFoundException,
                             OperationRejectedException,
                             ConcurrentModificationException,
                             org.forgerock.opendj.ldap.LdapException

Removes the Replication Server if it exists.

Throws:

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.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.