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

Class SchemaProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<SchemaProviderCfgClient,SchemaProviderCfg>

org.forgerock.opendj.server.config.meta.SchemaProviderCfgDefn

public final class SchemaProviderCfgDefn
extends ManagedObjectDefinition<SchemaProviderCfgClient,SchemaProviderCfg>

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

Schema Providers define the schema elements to load.

Method Summary

Modifier and Type	Method	Description
SchemaProviderCfgClient	createClientConfiguration(ManagedObject<? extends SchemaProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
SchemaProviderCfg	createServerConfiguration(ServerManagedObject<? extends SchemaProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SchemaProviderCfgDefn	getInstance()	Get the Schema Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<SchemaProviderCfg>	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 SchemaProviderCfgDefn getInstance()

Get the Schema Provider configuration definition singleton.

Returns:

Returns the Schema Provider configuration definition singleton.

createClientConfiguration

public SchemaProviderCfgClient createClientConfiguration(ManagedObject<? extends SchemaProviderCfgClient> 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<SchemaProviderCfgClient,SchemaProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SchemaProviderCfgClient,SchemaProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<SchemaProviderCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SchemaProviderCfgClient,SchemaProviderCfg>

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

Returns:

Returns the "java-class" property definition.