Package org.opends.server.schema

Class JsonOrderingMatchingRuleProvider

java.lang.Object

org.opends.server.schema.JsonOrderingMatchingRuleProvider

All Implemented Interfaces:

ConfigurationChangeListener<JsonOrderingMatchingRuleCfg>, SchemaProvider<JsonOrderingMatchingRuleCfg>

public final class JsonOrderingMatchingRuleProvider
extends Object
implements SchemaProvider<JsonOrderingMatchingRuleCfg>, ConfigurationChangeListener<JsonOrderingMatchingRuleCfg>

Allows users to configure JSON matching rules.

Constructor Summary

Constructors

Constructor	Description
JsonOrderingMatchingRuleProvider()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(JsonOrderingMatchingRuleCfg configuration)	Applies the configuration changes to this change listener.
void	finalizeProvider()	Finalize the provider.
void	initialize(ServerContext serverContext, JsonOrderingMatchingRuleCfg configuration, SchemaBuilder initialSchemaBuilder)	Initialize the schema provider from provided configuration and schema builder.
boolean	isConfigurationAcceptable(JsonOrderingMatchingRuleCfg config, List<LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this provider.
boolean	isConfigurationChangeAcceptable(JsonOrderingMatchingRuleCfg config, List<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

JsonOrderingMatchingRuleProvider

public JsonOrderingMatchingRuleProvider()

Method Detail

initialize

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

Description copied from interface: SchemaProvider

Initialize the schema provider from provided configuration and schema builder.

Specified by:

initialize in interface SchemaProvider<JsonOrderingMatchingRuleCfg>

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.

finalizeProvider

public void finalizeProvider()

Description copied from interface: SchemaProvider

Finalize the provider.

Specified by:

finalizeProvider in interface SchemaProvider<JsonOrderingMatchingRuleCfg>

isConfigurationAcceptable

public boolean isConfigurationAcceptable(JsonOrderingMatchingRuleCfg config,
                                         List<LocalizableMessage> unacceptableReasons)

Description copied from interface: SchemaProvider

Indicates whether the provided configuration is acceptable for this provider.

Specified by:

isConfigurationAcceptable in interface SchemaProvider<JsonOrderingMatchingRuleCfg>

Parameters:

config - 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(JsonOrderingMatchingRuleCfg config,
                                               List<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<JsonOrderingMatchingRuleCfg>

Parameters:

config - 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(JsonOrderingMatchingRuleCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<JsonOrderingMatchingRuleCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.