org.opends.server.schema

Interface SchemaProvider<T extends org.forgerock.opendj.server.config.server.SchemaProviderCfg>

Type Parameters:

T - The type of provider configuration.

All Known Implementing Classes:

CoreSchemaProvider

public interface SchemaProvider<T extends org.forgerock.opendj.server.config.server.SchemaProviderCfg>

Provides some schema elements to load at startup.

A schema provider must be able to update the provided SchemaBuilder at initialization and to use the provided SchemaUpdater to update the schema on further configuration changes.

Method Summary

Methods

Modifier and Type	Method and Description
void	finalizeProvider() Finalize the provider.
org.forgerock.opendj.ldap.schema.SchemaBuilder	getSchema() Returns the schema builder, as updated by this provider.
void	initialize(T configuration, org.forgerock.opendj.ldap.schema.SchemaBuilder initialSchemaBuilder, SchemaUpdater schemaUpdater) Initialize the schema provider from provided configuration and schema builder.
boolean	isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this provider.

Method Detail

initialize

void initialize(T configuration,
              org.forgerock.opendj.ldap.schema.SchemaBuilder initialSchemaBuilder,
              SchemaUpdater schemaUpdater)
                throws org.forgerock.opendj.config.server.ConfigException,
                       InitializationException

Initialize the schema provider from provided configuration and schema builder.

Parameters:

configuration - Configuration of the provider.

initialSchemaBuilder - Schema builder to update during initialization phase.

schemaUpdater - The updater to call when applying a configuration change.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem arises in the process of performing the initialization.

InitializationException - If a problem that is not configuration-related occurs during initialization.

finalizeProvider

void finalizeProvider()

Finalize the provider.

isConfigurationAcceptable

boolean isConfigurationAcceptable(T configuration,
                                List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided configuration is acceptable for this provider.

Parameters:

configuration - The provider configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this provider, or false if not.

getSchema

org.forgerock.opendj.ldap.schema.SchemaBuilder getSchema()

Returns the schema builder, as updated by this provider.

Returns:

the schema builder resulting from this provider.