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

Class ANDJSONObjectFilter

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.ANDJSONObjectFilter
All Implemented Interfaces:
Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ANDJSONObjectFilter extends JSONObjectFilter
This class provides an implementation of a JSON object filter that can perform a logical AND across the result obtained from a number of filters. The AND filter will match an object only if all of the filters contained in it match that object. An AND filter with an empty set of embedded filters will match any object.
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 "AND" filter are:
  • andFilters -- An array of JSON objects, each of which is a valid JSON object filter. Each of these filters must match a JSON object in order for the AND filter to match. If this is an empty array, then the filter will match any object.


Examples

The following is an example of an AND filter that will match any JSON object: 
   { "filterType" : "and",
     "andFilters" : [ ] }
The above filter can be created with the code: 
   ANDJSONObjectFilter filter = new ANDJSONObjectFilter();


The following is an example of an AND filter that will match any JSON object in which there is a top-level field named "firstName" with a String value of "John" and top-level field named "lastName" with a String value of "Doe": 
   { "filterType" : "and",
     "andFilters" : [
       { "filterType" : "equals",
          "field" : "firstName",
          "value" : "John" },
       { "filterType" : "equals",
          "field" : "lastName",
          "value" : "Doe" } ] }
The above filter can be created with the code: 
   ANDJSONObjectFilter filter = new ANDJSONObjectFilter(
        new EqualsJSONObjectFilter("firstName", "John"),
        new EqualsJSONObjectFilter("firstName", "Doe"));
See Also:

  • Field Details

  • Constructor Details

    • ANDJSONObjectFilter

      public ANDJSONObjectFilter(@Nullable JSONObjectFilter... andFilters)
      Creates a new instance of this filter type with the provided information.
      Parameters:
      andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

    • ANDJSONObjectFilter

      public ANDJSONObjectFilter(@Nullable Collection<JSONObjectFilter> andFilters)
      Creates a new instance of this filter type with the provided information.
      Parameters:
      andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

  • Method Details

    • getANDFilters

      @NotNull public List<JSONObjectFilter> getANDFilters()
      Retrieves the set of filters that must each match a JSON object in order for this AND filter to match.
      Returns:
      The set of filters that must each match a JSON object in order for this AND filter to match, or an empty list if this AND filter should match any JSON object.

    • setANDFilters

      public void setANDFilters(@Nullable JSONObjectFilter... andFilters)
      Specifies the set of AND filters that must each match a JSON object in order for this AND filter to match.
      Parameters:
      andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

    • setANDFilters

      public void setANDFilters(@Nullable Collection<JSONObjectFilter> andFilters)
      Specifies the set of AND filters that must each match a JSON object in order for this AND filter to match.
      Parameters:
      andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

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