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

Interface JsonSchemaCfg

All Superinterfaces:

Configuration, SchemaProviderCfg

public interface JsonSchemaCfg
extends SchemaProviderCfg

A server-side interface for querying Json Schema settings.

The JSON Schema Provider provides the ability to configure customized JSON query matching rules.

Method Summary

Modifier and Type	Method	Description
void	addJsonSchemaChangeListener(ConfigurationChangeListener<JsonSchemaCfg> listener)	Register to be notified when this Json Schema is changed.
Class<? extends JsonSchemaCfg>	configurationClass()	Gets the configuration class associated with this Json Schema.
SortedSet<String>	getIndexedField()	Gets the "indexed-field" property.
String	getJavaClass()	Gets the "java-class" property.
String	getMatchingRuleName()	Gets the "matching-rule-name" property.
String	getMatchingRuleOid()	Gets the "matching-rule-oid" property.
boolean	isCaseSensitiveStrings()	Gets the "case-sensitive-strings" property.
boolean	isIgnoreWhiteSpace()	Gets the "ignore-white-space" property.
void	removeJsonSchemaChangeListener(ConfigurationChangeListener<JsonSchemaCfg> listener)	Deregister an existing Json Schema configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.SchemaProviderCfg

addChangeListener, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends JsonSchemaCfg> configurationClass()

Gets the configuration class associated with this Json Schema.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface SchemaProviderCfg

Returns:

Returns the configuration class associated with this Json Schema.

addJsonSchemaChangeListener

void addJsonSchemaChangeListener(ConfigurationChangeListener<JsonSchemaCfg> listener)

Register to be notified when this Json Schema is changed.

Parameters:

listener - The Json Schema configuration change listener.

removeJsonSchemaChangeListener

void removeJsonSchemaChangeListener(ConfigurationChangeListener<JsonSchemaCfg> listener)

Deregister an existing Json Schema configuration change listener.

Parameters:

listener - The Json Schema configuration change listener.

isCaseSensitiveStrings

boolean isCaseSensitiveStrings()

Gets the "case-sensitive-strings" property.

Indicates whether JSON string comparisons should be case-sensitive.

Returns:

Returns the value of the "case-sensitive-strings" property.

isIgnoreWhiteSpace

boolean isIgnoreWhiteSpace()

Gets the "ignore-white-space" property.

Indicates whether JSON string comparisons should ignore white-space.

When enabled all leading and trailing white space will be removed and intermediate white space will be reduced to a single character.

Returns:

Returns the value of the "ignore-white-space" property.

getIndexedField

SortedSet<String> getIndexedField()

Gets the "indexed-field" property.

Specifies which JSON fields should be indexed.

A field will be indexed if it matches any of the configured field patterns.

Returns:

Returns an unmodifiable set containing the values of the "indexed-field" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Json Schema implementation.

Specified by:

getJavaClass in interface SchemaProviderCfg

Returns:

Returns the value of the "java-class" property.

getMatchingRuleName

String getMatchingRuleName()

Gets the "matching-rule-name" property.

The name of the custom JSON matching rule.

Returns:

Returns the value of the "matching-rule-name" property.

getMatchingRuleOid

String getMatchingRuleOid()

Gets the "matching-rule-oid" property.

The numeric OID of the custom JSON matching rule.

Returns:

Returns the value of the "matching-rule-oid" property.