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

Interface JsonQueryEqualityMatchingRuleCfgClient

All Superinterfaces:

ConfigurationClient, SchemaProviderCfgClient

public interface JsonQueryEqualityMatchingRuleCfgClient
extends SchemaProviderCfgClient

A client-side interface for reading and modifying JSON Query Equality Matching Rule settings.

The JSON Query Equality Matching Rule Provider provides the ability to configure customized JSON query equality matching rules.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends JsonQueryEqualityMatchingRuleCfgClient,? extends JsonQueryEqualityMatchingRuleCfg>	definition()	Get the configuration definition associated with this JSON Query Equality Matching Rule.
SortedSet<ValueOrExpression<String>>	getIndexedField()	Gets the "indexed-field" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getMatchingRuleName()	Gets the "matching-rule-name" property.
ValueOrExpression<String>	getMatchingRuleOid()	Gets the "matching-rule-oid" property.
ValueOrExpression<Boolean>	isCaseSensitiveStrings()	Gets the "case-sensitive-strings" property.
ValueOrExpression<Boolean>	isIgnoreWhiteSpace()	Gets the "ignore-white-space" property.
void	setCaseSensitiveStrings(ValueOrExpression<Boolean> value)	Sets the "case-sensitive-strings" property.
void	setIgnoreWhiteSpace(ValueOrExpression<Boolean> value)	Sets the "ignore-white-space" property.
void	setIndexedField(Collection<ValueOrExpression<String>> values)	Sets the "indexed-field" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setMatchingRuleName(ValueOrExpression<String> value)	Sets the "matching-rule-name" property.
void	setMatchingRuleOid(ValueOrExpression<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 JsonQueryEqualityMatchingRuleCfgClient,? extends JsonQueryEqualityMatchingRuleCfg> definition()

Get the configuration definition associated with this JSON Query Equality Matching Rule.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface SchemaProviderCfgClient

Returns:

Returns the configuration definition associated with this JSON Query Equality Matching Rule.

isCaseSensitiveStrings

ValueOrExpression<Boolean> isCaseSensitiveStrings()

Gets the "case-sensitive-strings" property.

Indicates whether JSON string comparisons should be case-sensitive.

Default value: false

Returns:

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

setCaseSensitiveStrings

void setCaseSensitiveStrings(ValueOrExpression<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

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

Default value: true

Returns:

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

setIgnoreWhiteSpace

void setIgnoreWhiteSpace(ValueOrExpression<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<ValueOrExpression<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<ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the JSON Query Equality Matching Rule implementation.

Default value: org.opends.server.schema.JsonQueryEqualityMatchingRuleProvider

Specified by:

getJavaClass in interface SchemaProviderCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the JSON Query Equality Matching Rule 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

ValueOrExpression<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(ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setMatchingRuleOid(ValueOrExpression<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.