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

Class ObjectMatchesJSONObjectFilter

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.ObjectMatchesJSONObjectFilter
All Implemented Interfaces:
Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ObjectMatchesJSONObjectFilter extends JSONObjectFilter
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a field whose value is a JSON object that matches a provided JSON object filter, or a field whose value is an array that contains at least one JSON object that matches the provided filter.
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.

The fields that are required to be included in an "object matches" filter are:
  • field -- A field path specifier for the JSON field for which to make the determination. This may be either a single string or an array of strings as described in the "Targeting Fields in JSON Objects" section of the class-level documentation for JSONObjectFilter. The value of the target field is expected to either be a JSON object or an array that contains one or more JSON objects.
  • filter -- A JSON object that represents a valid JSON object filter to match against any JSON object(s) in the value of the target field. Note that field name references in this filter should be relative to the object in the value of the target field, not to the other JSON object that contains that field.

Example

The following is an example of an "object matches" filter that will match any JSON object with a top-level field named "contact" whose value is a JSON object (or an array containing one or more JSON objects) with a "type" field with a value of "home" and a "email" field with any value: 
   { "filterType" : "objectMatches",
     "field" : "contact",
     "filter" : {
       "filterType" : "and",
       "andFilters" : [
         { "filterType" : "equals",
           "field" : "type",
           "value" : "home" },
         { "filterType" : "containsField",
           "field" : "email" } ] } }
The above filter can be created with the code: 
   ObjectMatchesJSONObjectFilter filter = new ObjectMatchesJSONObjectFilter(
        "contact",
        new ANDJSONObjectFilter(
             new EqualsJSONObjectFilter("type", "home"),
             new ContainsFieldJSONObjectFilter("email")));
See Also:

  • Field Details

  • Constructor Details

    • ObjectMatchesJSONObjectFilter

      public ObjectMatchesJSONObjectFilter(@NotNull String field, @NotNull JSONObjectFilter filter)
      Creates a new instance of this filter type with the provided information.
      Parameters:
      field - The name of the top-level field to target with this filter. It must not be null . See the class-level documentation for the JSONObjectFilter class for information about field path specifiers.
      filter - The filter that will be matched against JSON objects contained in the specified field.

    • ObjectMatchesJSONObjectFilter

      public ObjectMatchesJSONObjectFilter(@NotNull List<String> field, @NotNull JSONObjectFilter filter)
      Creates a new instance of this filter type with the provided information.
      Parameters:
      field - The field path specifier for this filter. It must not be null or empty. See the class-level documentation for the JSONObjectFilter class for information about field path specifiers.
      filter - The filter that will be matched against JSON objects contained in the specified field.

  • Method Details

    • getField

      @NotNull public List<String> getField()
      Retrieves the field path specifier for this filter.
      Returns:
      The field path specifier for this filter.

    • setField

      public void setField(@NotNull String... field)
      Sets the field path specifier for this filter.
      Parameters:
      field - The field path specifier for this filter. It must not be null or empty. See the class-level documentation for the JSONObjectFilter class for information about field path specifiers.

    • setField

      public void setField(@NotNull List<String> field)
      Sets the field path specifier for this filter.
      Parameters:
      field - The field path specifier for this filter. It must not be null or empty. See the class-level documentation for the JSONObjectFilter class for information about field path specifiers.

    • getFilter

      @NotNull public JSONObjectFilter getFilter()
      Retrieves the filter that will be matched against any JSON objects contained in the value of the specified field.
      Returns:
      The filter that will be matched against any JSON objects contained in the value of the specified field.

    • setFilter

      public void setFilter(@NotNull JSONObjectFilter filter)
      Specifies the filter that will be matched against any JSON objects contained in the value of the specified field.
      Parameters:
      filter - The filter that will be matched against any JSON objects contained in the value of the specified field. It must not be null.

    • getFilterType

      @NotNull public String getFilterType()
      Retrieves the value that must appear in the filterType field for this filter.
      Specified by:
      getFilterType in class JSONObjectFilter
      Returns:
      The value that must appear in the filterType field for this filter.

    • getRequiredFieldNames

      @NotNull protected Set<String> getRequiredFieldNames()
      Retrieves the names of all fields (excluding the filterType field) that must be present in the JSON object representing a filter of this type.
      Specified by:
      getRequiredFieldNames in class JSONObjectFilter
      Returns:
      The names of all fields (excluding the filterType field) that must be present in the JSON object representing a filter of this type.

    • getOptionalFieldNames

      @NotNull protected Set<String> getOptionalFieldNames()
      Retrieves the names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type.
      Specified by:
      getOptionalFieldNames in class JSONObjectFilter
      Returns:
      The names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type.

    • matchesJSONObject

      public boolean matchesJSONObject(@NotNull JSONObject o)
      Indicates whether this JSON object filter matches the provided JSON object.
      Specified by:
      matchesJSONObject in class JSONObjectFilter
      Parameters:
      o - The JSON object for which to make the determination.
      Returns:
      true if this JSON object filter matches the provided JSON object, or false if not.

    • toJSONObject

      @NotNull public JSONObject toJSONObject()
      Retrieves a JSON object that represents this filter.
      Specified by:
      toJSONObject in class JSONObjectFilter
      Returns:
      A JSON object that represents this filter.

    • toNormalizedJSONObject

      @NotNull public JSONObject toNormalizedJSONObject()
      Retrieves a JSON object that represents a normalized version of this filter.
      Specified by:
      toNormalizedJSONObject in class JSONObjectFilter
      Returns:
      A JSON object that represents a normalized version of this filter.

    • decodeFilter

      @NotNull protected ObjectMatchesJSONObjectFilter decodeFilter(@NotNull JSONObject filterObject) throws JSONException
      Decodes the provided JSON object as a filter of this type.
      Specified by:
      decodeFilter in class JSONObjectFilter
      Parameters:
      filterObject - The JSON object to be decoded. The caller will have already validated that all required fields are present, and that it does not have any fields that are neither required nor optional.
      Returns:
      The decoded JSON object filter.
      Throws:
      JSONException - If the provided JSON object cannot be decoded as a valid filter of this type.