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

Interface JsonOrderingMatchingRuleCfg

  • All Superinterfaces:
    Configuration, SchemaProviderCfg
    public interface JsonOrderingMatchingRuleCfg
extends SchemaProviderCfg
    A server-side interface for querying JSON Ordering Matching Rule settings.

    JSON Ordering Matching Rules determine the relative order of two JSON values using a custom set of rules.

    • Method Detail

      • addJsonOrderingMatchingRuleChangeListener

        void addJsonOrderingMatchingRuleChangeListener​(ConfigurationChangeListener<JsonOrderingMatchingRuleCfg> listener)
        Register to be notified when this JSON Ordering Matching Rule is changed.
        Parameters:
        listener - The JSON Ordering Matching Rule configuration change listener.

      • removeJsonOrderingMatchingRuleChangeListener

        void removeJsonOrderingMatchingRuleChangeListener​(ConfigurationChangeListener<JsonOrderingMatchingRuleCfg> listener)
        Deregister an existing JSON Ordering Matching Rule configuration change listener.
        Parameters:
        listener - The JSON Ordering 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.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

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

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

        Specified by:
        getJavaClass in interface SchemaProviderCfg
        Returns:
        Returns the value of the "java-class" property.

      • getJsonKeys

        String getJsonKeys()
        Gets the "json-keys" property.

        Specifies which JSON fields should be compared in order to determine the relative order of two JSON objects

        This parameter is a list of space-delimited JSON pointers.

        Returns:
        Returns the value of the "json-keys" 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.