Package org.forgerock.opendj.server.config.meta

Class SynchronizationProviderCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg>

org.forgerock.opendj.server.config.meta.SynchronizationProviderCfgDefn

public final class SynchronizationProviderCfgDefn
extends ManagedObjectDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg>

An interface for querying the Synchronization Provider managed object definition meta information.

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
SynchronizationProviderCfgClient	createClientConfiguration(ManagedObject<? extends SynchronizationProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
SynchronizationProviderCfg	createServerConfiguration(ServerManagedObject<? extends SynchronizationProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SynchronizationProviderCfgDefn	getInstance()	Get the Synchronization Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<SynchronizationProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getInstance

public static SynchronizationProviderCfgDefn getInstance()

Get the Synchronization Provider configuration definition singleton.

Returns:

Returns the Synchronization Provider configuration definition singleton.

createClientConfiguration

public SynchronizationProviderCfgClient createClientConfiguration(ManagedObject<? extends SynchronizationProviderCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public SynchronizationProviderCfg createServerConfiguration(ServerManagedObject<? extends SynchronizationProviderCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<SynchronizationProviderCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SynchronizationProviderCfgClient,SynchronizationProviderCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Synchronization Provider is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.