org.opends.server.schema

Class JsonSchemaProvider

java.lang.Object

org.opends.server.schema.JsonSchemaProvider

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.JsonSchemaCfg>, SchemaProvider<org.forgerock.opendj.server.config.server.JsonSchemaCfg>

public class JsonSchemaProvider
extends Object
implements SchemaProvider<org.forgerock.opendj.server.config.server.JsonSchemaCfg>, org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.JsonSchemaCfg>

Allows users to configure custom JSON matching rules and indexing.

Constructor Summary

Constructors

Constructor and Description
JsonSchemaProvider()

Method Summary

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

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,
                       org.forgerock.opendj.server.config.server.JsonSchemaCfg configuration,
                       org.forgerock.opendj.ldap.schema.SchemaBuilder initialSchemaBuilder)
                throws org.forgerock.opendj.config.server.ConfigException,
                       InitializationException

Description copied from interface: SchemaProvider

Initialize the schema provider from provided configuration and schema builder.

Specified by:

initialize in interface SchemaProvider<org.forgerock.opendj.server.config.server.JsonSchemaCfg>

Parameters:

serverContext - The server context.

configuration - Configuration of the provider.

initialSchemaBuilder - Schema builder to update during initialization phase.

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

public void finalizeProvider()

Description copied from interface: SchemaProvider

Finalize the provider.

Specified by:

finalizeProvider in interface SchemaProvider<org.forgerock.opendj.server.config.server.JsonSchemaCfg>

isConfigurationAcceptable

public boolean isConfigurationAcceptable(org.forgerock.opendj.server.config.server.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<org.forgerock.opendj.server.config.server.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(org.forgerock.opendj.server.config.server.JsonSchemaCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.JsonSchemaCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.JsonSchemaCfg configuration)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.JsonSchemaCfg>