|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReplicationSynchronizationProviderCfgClient
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 | ||
---|---|---|
|
createReplicationDomain(ManagedObjectDefinition<C,? extends ReplicationDomainCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Replication Domain. |
|
|
createReplicationServer(ManagedObjectDefinition<C,? extends ReplicationServerCfg> d,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Replication Server. |
|
ManagedObjectDefinition<? extends ReplicationSynchronizationProviderCfgClient,? extends ReplicationSynchronizationProviderCfg> |
definition()
Get the configuration definition associated with this Replication Synchronization Provider. |
|
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
|
int |
getNumUpdateReplayThreads()
Gets the "num-update-replay-threads" property. |
|
ReplicationDomainCfgClient |
getReplicationDomain(java.lang.String name)
Gets the named Replication Domain. |
|
ReplicationServerCfgClient |
getReplicationServer()
Gets the Replication Server if it is present. |
|
boolean |
hasReplicationServer()
Determines whether or not the Replication Server exists. |
|
java.lang.String[] |
listReplicationDomains()
Lists the Replication Domains. |
|
void |
removeReplicationDomain(java.lang.String name)
Removes the named Replication Domain. |
|
void |
removeReplicationServer()
Removes the Replication Server if it exists. |
|
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
|
void |
setNumUpdateReplayThreads(java.lang.Integer value)
Sets the "num-update-replay-threads" property. |
Methods inherited from interface org.opends.server.admin.std.client.SynchronizationProviderCfgClient |
---|
isEnabled, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends ReplicationSynchronizationProviderCfgClient,? extends ReplicationSynchronizationProviderCfg> definition()
definition
in interface ConfigurationClient
definition
in interface SynchronizationProviderCfgClient
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Replication Synchronization Provider implementation.
getJavaClass
in interface SynchronizationProviderCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.int 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(java.lang.Integer value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String[] listReplicationDomains() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.
AuthorizationException
- If the server refuses to list the Replication Domains
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.ReplicationDomainCfgClient getReplicationDomain(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
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.
AuthorizationException
- If the server refuses to retrieve the named Replication
Domain because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends ReplicationDomainCfgClient> C createReplicationDomain(ManagedObjectDefinition<C,? extends ReplicationDomainCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> 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 DefaultBehaviorException
s 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.
void removeReplicationDomain(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
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.
AuthorizationException
- If the server refuses to remove the Replication Domain
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.boolean hasReplicationServer() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Replication Synchronization Provider has been
removed from the server by another client.
AuthorizationException
- If the server refuses to make the determination because
the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.ReplicationServerCfgClient getReplicationServer() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
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.
AuthorizationException
- If the server refuses to retrieve the Replication
Server because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends ReplicationServerCfgClient> C createReplicationServer(ManagedObjectDefinition<C,? extends ReplicationServerCfg> d, java.util.Collection<DefaultBehaviorException> 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 DefaultBehaviorException
s 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.
void removeReplicationServer() throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
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.
AuthorizationException
- If the server refuses to remove the Replication Server
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |