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

Interface JsonSchemaCfgClient

All Superinterfaces:

ConfigurationClient, SchemaProviderCfgClient

public interface JsonSchemaCfgClient
extends SchemaProviderCfgClient

A client-side interface for reading and modifying Json Schema settings.

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

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends JsonSchemaCfgClient,? extends JsonSchemaCfg>	definition()	Get the configuration definition 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	setCaseSensitiveStrings(Boolean value)	Sets the "case-sensitive-strings" property.
void	setIgnoreWhiteSpace(Boolean value)	Sets the "ignore-white-space" property.
void	setIndexedField(Collection<String> values)	Sets the "indexed-field" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setMatchingRuleName(String value)	Sets the "matching-rule-name" property.
void	setMatchingRuleOid(String value)	Sets the "matching-rule-oid" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.SchemaProviderCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends JsonSchemaCfgClient,? extends JsonSchemaCfg> definition()

Get the configuration definition associated with this Json Schema.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface SchemaProviderCfgClient

Returns:

Returns the configuration definition associated with this Json Schema.

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.

setCaseSensitiveStrings

void setCaseSensitiveStrings(Boolean value)
                      throws PropertyException

Sets the "case-sensitive-strings" property.

Indicates whether JSON string comparisons should be case-sensitive.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setIgnoreWhiteSpace

void setIgnoreWhiteSpace(Boolean value)
                  throws PropertyException

Sets 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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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 the values of the "indexed-field" property.

setIndexedField

void setIndexedField(Collection<String> values)
              throws PropertyException

Sets 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.

Parameters:

values - The values of the "indexed-field" property.

Throws:

PropertyException - If one or more of the new values are invalid.

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 SchemaProviderCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface SchemaProviderCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setMatchingRuleName

void setMatchingRuleName(String value)
                  throws PropertyException

Sets the "matching-rule-name" property.

The name of the custom JSON matching rule.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setMatchingRuleOid

void setMatchingRuleOid(String value)
                 throws PropertyException

Sets the "matching-rule-oid" property.

The numeric OID of the custom JSON matching rule.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.