Interface JsonOrderingMatchingRuleCfgClient

  • All Superinterfaces:
    ConfigurationClient, SchemaProviderCfgClient

    public interface JsonOrderingMatchingRuleCfgClient
    extends SchemaProviderCfgClient
    A client-side interface for reading and modifying 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

      • 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.
      • getJavaClass

        @MandatoryProperty
        ValueOrExpression<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 SchemaProviderCfgClient
        Returns:
        Returns the value of the "java-class" property.
      • getJsonKeys

        @MandatoryProperty
        ValueOrExpression<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.
      • setJsonKeys

        @MandatoryProperty
        void setJsonKeys​(ValueOrExpression<String> value)
                  throws PropertyException
        Sets 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.

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