Package com.unboundid.ldap.sdk.unboundidds.jsonfilter

Class JSONObjectExactMatchingRule

java.lang.Object
com.unboundid.ldap.matchingrules.MatchingRule
com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectExactMatchingRule
All Implemented Interfaces:
Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONObjectExactMatchingRule extends MatchingRule
This class provides an implementation of a matching rule that can be used in conjunction with JSON objects.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
See Also:

  • Constructor Details

  • Method Details

    • getInstance

      @NotNull public static JSONObjectExactMatchingRule getInstance()
      Retrieves a singleton instance of this matching rule.
      Returns:
      A singleton instance of this matching rule.

    • getEqualityMatchingRuleName

      @NotNull public String getEqualityMatchingRuleName()
      Retrieves the name for this matching rule when used to perform equality matching, if appropriate.
      Specified by:
      getEqualityMatchingRuleName in class MatchingRule
      Returns:
      The name for this matching rule when used to perform equality matching, or null if this matching rule is not intended to be used for equality matching.

    • getEqualityMatchingRuleOID

      @NotNull public String getEqualityMatchingRuleOID()
      Retrieves the OID for this matching rule when used to perform equality matching, if appropriate.
      Specified by:
      getEqualityMatchingRuleOID in class MatchingRule
      Returns:
      The OID for this matching rule when used to perform equality matching, or null if this matching rule is not intended to be used for equality matching.

    • getOrderingMatchingRuleName

      @Nullable public String getOrderingMatchingRuleName()
      Retrieves the name for this matching rule when used to perform ordering matching, if appropriate.
      Specified by:
      getOrderingMatchingRuleName in class MatchingRule
      Returns:
      The name for this matching rule when used to perform ordering matching, or null if this matching rule is not intended to be used for ordering matching.

    • getOrderingMatchingRuleOID

      @Nullable public String getOrderingMatchingRuleOID()
      Retrieves the OID for this matching rule when used to perform ordering matching, if appropriate.
      Specified by:
      getOrderingMatchingRuleOID in class MatchingRule
      Returns:
      The OID for this matching rule when used to perform ordering matching, or null if this matching rule is not intended to be used for ordering matching.

    • getSubstringMatchingRuleName

      @Nullable public String getSubstringMatchingRuleName()
      Retrieves the name for this matching rule when used to perform substring matching, if appropriate.
      Specified by:
      getSubstringMatchingRuleName in class MatchingRule
      Returns:
      The name for this matching rule when used to perform substring matching, or null if this matching rule is not intended to be used for substring matching.

    • getSubstringMatchingRuleOID

      @Nullable public String getSubstringMatchingRuleOID()
      Retrieves the OID for this matching rule when used to perform substring matching, if appropriate.
      Specified by:
      getSubstringMatchingRuleOID in class MatchingRule
      Returns:
      The OID for this matching rule when used to perform substring matching, or null if this matching rule is not intended to be used for substring matching.

    • valuesMatch

      public boolean valuesMatch(@NotNull ASN1OctetString value1, @NotNull ASN1OctetString value2) throws LDAPException
      Indicates whether the provided values are equal to each other, according to the constraints of this matching rule.
      Specified by:
      valuesMatch in class MatchingRule
      Parameters:
      value1 - The first value for which to make the determination.
      value2 - The second value for which to make the determination.
      Returns:
      true if the provided values are considered equal, or false if not.
      Throws:
      LDAPException - If a problem occurs while making the determination, or if this matching rule does not support equality matching.

    • matchesSubstring

      public boolean matchesSubstring(@NotNull ASN1OctetString value, @Nullable ASN1OctetString subInitial, @Nullable ASN1OctetString[] subAny, @Nullable ASN1OctetString subFinal) throws LDAPException
      Indicates whether the provided value matches the given substring assertion, according to the constraints of this matching rule.
      Specified by:
      matchesSubstring in class MatchingRule
      Parameters:
      value - The value for which to make the determination.
      subInitial - The subInitial portion of the substring assertion, or null if there is no subInitial element.
      subAny - The subAny elements of the substring assertion, or null if there are no subAny elements.
      subFinal - The subFinal portion of the substring assertion, or null if there is no subFinal element.
      Returns:
      true if the provided value matches the substring assertion, or false if not.
      Throws:
      LDAPException - If a problem occurs while making the determination, or if this matching rule does not support substring matching.

    • compareValues

      public int compareValues(@NotNull ASN1OctetString value1, @NotNull ASN1OctetString value2) throws LDAPException
      Compares the provided values to determine their relative order in a sorted list.
      Specified by:
      compareValues in class MatchingRule
      Parameters:
      value1 - The first value to compare.
      value2 - The second value to compare.
      Returns:
      A negative value if value1 should come before value2 in a sorted list, a positive value if value1 should come after value2 in a sorted list, or zero if the values are equal or there is no distinction between their orders in a sorted list.
      Throws:
      LDAPException - If a problem occurs while making the determination, or if this matching rule does not support ordering matching.

    • normalize

      @NotNull public ASN1OctetString normalize(@NotNull ASN1OctetString value) throws LDAPException
      Normalizes the provided value for easier matching.
      Specified by:
      normalize in class MatchingRule
      Parameters:
      value - The value to be normalized.
      Returns:
      The normalized form of the provided value.
      Throws:
      LDAPException - If a problem occurs while normalizing the provided value.

    • normalizeSubstring

      @NotNull public ASN1OctetString normalizeSubstring(@NotNull ASN1OctetString value, byte substringType) throws LDAPException
      Normalizes the provided value for use as part of a substring assertion.
      Specified by:
      normalizeSubstring in class MatchingRule
      Parameters:
      value - The value to be normalized for use as part of a substring assertion.
      substringType - The substring assertion component type for the provided value. It should be one of SUBSTRING_TYPE_SUBINITIAL, SUBSTRING_TYPE_SUBANY, or SUBSTRING_TYPE_SUBFINAL.
      Returns:
      The normalized form of the provided value.
      Throws:
      LDAPException - If a problem occurs while normalizing the provided value.