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

Interface NameAndJsonQueryEqualityMatchingRuleCfg

All Superinterfaces:
Configuration, SchemaProviderCfg
public interface NameAndJsonQueryEqualityMatchingRuleCfg extends SchemaProviderCfg
A server-side interface for querying Name And JSON Query Equality Matching Rule settings.

The Name And JSON Query Equality Matching Rule Provider provides the ability to configure customized JSON query equality matching rules... (WARNING: private interface)

  • Method Details

    • configurationClass

      Class<? extends NameAndJsonQueryEqualityMatchingRuleCfg> configurationClass()
      Gets the configuration class associated with this Name And JSON Query Equality Matching Rule.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface SchemaProviderCfg
      Returns:
      Returns the configuration class associated with this Name And JSON Query Equality Matching Rule.

    • addNameAndJsonQueryEqualityMatchingRuleChangeListener

      void addNameAndJsonQueryEqualityMatchingRuleChangeListener(ConfigurationChangeListener<NameAndJsonQueryEqualityMatchingRuleCfg> listener)
      Register to be notified when this Name And JSON Query Equality Matching Rule is changed.
      Parameters:
      listener - The Name And JSON Query Equality Matching Rule configuration change listener.

    • removeNameAndJsonQueryEqualityMatchingRuleChangeListener

      void removeNameAndJsonQueryEqualityMatchingRuleChangeListener(ConfigurationChangeListener<NameAndJsonQueryEqualityMatchingRuleCfg> listener)
      Deregister an existing Name And JSON Query Equality Matching Rule configuration change listener.
      Parameters:
      listener - The Name And 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 Name And JSON Query Equality Matching Rule implementation.

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

      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.