Interface JsonQueryEqualityMatchingRuleCfg
-
- All Superinterfaces:
Configuration
,SchemaProviderCfg
public interface JsonQueryEqualityMatchingRuleCfg extends SchemaProviderCfg
A server-side interface for querying 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addJsonQueryEqualityMatchingRuleChangeListener(ConfigurationChangeListener<JsonQueryEqualityMatchingRuleCfg> listener)
Register to be notified when this JSON Query Equality Matching Rule is changed.Class<? extends JsonQueryEqualityMatchingRuleCfg>
configurationClass()
Gets the configuration class associated with this JSON Query Equality Matching Rule.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
removeJsonQueryEqualityMatchingRuleChangeListener(ConfigurationChangeListener<JsonQueryEqualityMatchingRuleCfg> listener)
Deregister an existing JSON Query Equality Matching Rule 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 JsonQueryEqualityMatchingRuleCfg> configurationClass()
Gets the configuration class associated with this JSON Query Equality Matching Rule.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceSchemaProviderCfg
- Returns:
- Returns the configuration class associated with this JSON Query Equality Matching Rule.
-
addJsonQueryEqualityMatchingRuleChangeListener
void addJsonQueryEqualityMatchingRuleChangeListener(ConfigurationChangeListener<JsonQueryEqualityMatchingRuleCfg> listener)
Register to be notified when this JSON Query Equality Matching Rule is changed.- Parameters:
listener
- The JSON Query Equality Matching Rule configuration change listener.
-
removeJsonQueryEqualityMatchingRuleChangeListener
void removeJsonQueryEqualityMatchingRuleChangeListener(ConfigurationChangeListener<JsonQueryEqualityMatchingRuleCfg> listener)
Deregister an existing JSON Query Equality Matching Rule configuration change listener.- Parameters:
listener
- The JSON Query Equality Matching Rule configuration change listener.
-
isCaseSensitiveStrings
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.
-
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.
Default value:
true
- 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 Query Equality Matching Rule implementation.
Default value:
org.opends.server.schema.JsonQueryEqualityMatchingRuleProvider
- Specified by:
getJavaClass
in interfaceSchemaProviderCfg
- 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.
-
-