Package org.opends.server.schema

Class JsonSchemaProvider

java.lang.Object

org.opends.server.schema.JsonSchemaProvider

All Implemented Interfaces:

ConfigurationChangeListener<JsonSchemaCfg>, SchemaProvider<JsonSchemaCfg>

public class JsonSchemaProvider
extends Object
implements SchemaProvider<JsonSchemaCfg>, ConfigurationChangeListener<JsonSchemaCfg>

Allows users to configure custom JSON matching rules and indexing.

Constructor Summary

Constructors

Constructor	Description
JsonSchemaProvider()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(JsonSchemaCfg configuration)	Applies the configuration changes to this change listener.
void	finalizeProvider()	Finalize the provider.
void	initialize(ServerContext serverContext, JsonSchemaCfg configuration, SchemaBuilder initialSchemaBuilder)	Initialize the schema provider from provided configuration and schema builder.
boolean	isConfigurationAcceptable(JsonSchemaCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this provider.
boolean	isConfigurationChangeAcceptable(JsonSchemaCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaProvider

public JsonSchemaProvider()

Method Detail

initialize

public void initialize(ServerContext serverContext,
                       JsonSchemaCfg configuration,
                       SchemaBuilder initialSchemaBuilder)
                throws ConfigException,
                       InitializationException

Description copied from interface: SchemaProvider

Initialize the schema provider from provided configuration and schema builder.

Specified by:

initialize in interface SchemaProvider<JsonSchemaCfg>

Parameters:

serverContext - The server context.

configuration - Configuration of the provider.

initialSchemaBuilder - Schema builder to update during initialization phase.

Throws:

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

public void finalizeProvider()

Description copied from interface: SchemaProvider

Finalize the provider.

Specified by:

finalizeProvider in interface SchemaProvider<JsonSchemaCfg>

isConfigurationAcceptable

public boolean isConfigurationAcceptable(JsonSchemaCfg configuration,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Description copied from interface: SchemaProvider

Indicates whether the provided configuration is acceptable for this provider.

Specified by:

isConfigurationAcceptable in interface SchemaProvider<JsonSchemaCfg>

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.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(JsonSchemaCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<JsonSchemaCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(JsonSchemaCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<JsonSchemaCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.