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

Interface SynchronizationProviderCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

ReplicationSynchronizationProviderCfgClient

public interface SynchronizationProviderCfgClient
extends ConfigurationClient

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

Synchronization Providers are responsible for handling synchronization of the directory server data with other OpenDJ instances or other data repositories.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends SynchronizationProviderCfgClient,? extends SynchronizationProviderCfg>	definition()	Get the configuration definition associated with this Synchronization Provider.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

Method Details

definition

ManagedObjectDefinition<? extends SynchronizationProviderCfgClient,? extends SynchronizationProviderCfg> definition()

Get the configuration definition associated with this Synchronization Provider.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Synchronization Provider.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the Synchronization Provider is enabled for use.

Returns:

Returns the value of the "enabled" property.

setEnabled

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

Sets the "enabled" property.

Indicates whether the Synchronization Provider is enabled for use.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Synchronization Provider implementation.

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Synchronization Provider implementation.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.