Class ObjectMatchesJSONObjectFilter
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
-
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.ObjectMatchesJSONObjectFilter
-
- All Implemented Interfaces:
java.io.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 forJSONObjectFilter
. 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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FIELD_FIELD_PATH
The name of the JSON field that is used to specify the field in the target JSON object for which to make the determination.static java.lang.String
FIELD_FILTER
The name of the JSON field that is used to specify the filter to match against the object in the target field.static java.lang.String
FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "object matches" filter.-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
FIELD_FILTER_TYPE, JSON_OBJECT_FILTER_MATCHING_RULE_NAME, JSON_OBJECT_FILTER_MATCHING_RULE_OID
-
-
Constructor Summary
Constructors Constructor Description ObjectMatchesJSONObjectFilter(java.lang.String field, JSONObjectFilter filter)
Creates a new instance of this filter type with the provided information.ObjectMatchesJSONObjectFilter(java.util.List<java.lang.String> field, JSONObjectFilter filter)
Creates a new instance of this filter type with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ObjectMatchesJSONObjectFilter
decodeFilter(JSONObject filterObject)
Decodes the provided JSON object as a filter of this type.java.util.List<java.lang.String>
getField()
Retrieves the field path specifier for this filter.JSONObjectFilter
getFilter()
Retrieves the filter that will be matched against any JSON objects contained in the value of the specified field.java.lang.String
getFilterType()
Retrieves the value that must appear in thefilterType
field for this filter.protected java.util.Set<java.lang.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.protected java.util.Set<java.lang.String>
getRequiredFieldNames()
Retrieves the names of all fields (excluding thefilterType
field) that must be present in the JSON object representing a filter of this type.boolean
matchesJSONObject(JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object.void
setField(java.lang.String... field)
Sets the field path specifier for this filter.void
setField(java.util.List<java.lang.String> field)
Sets the field path specifier for this filter.void
setFilter(JSONObjectFilter filter)
Specifies the filter that will be matched against any JSON objects contained in the value of the specified field.JSONObject
toJSONObject()
Retrieves a JSON object that represents this filter.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toString, toString
-
-
-
-
Field Detail
-
FILTER_TYPE
@NotNull public static final java.lang.String FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "object matches" filter.- See Also:
- Constant Field Values
-
FIELD_FIELD_PATH
@NotNull public static final java.lang.String FIELD_FIELD_PATH
The name of the JSON field that is used to specify the field in the target JSON object for which to make the determination.- See Also:
- Constant Field Values
-
FIELD_FILTER
@NotNull public static final java.lang.String FIELD_FILTER
The name of the JSON field that is used to specify the filter to match against the object in the target field.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ObjectMatchesJSONObjectFilter
public ObjectMatchesJSONObjectFilter(@NotNull java.lang.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 benull
. See the class-level documentation for theJSONObjectFilter
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 java.util.List<java.lang.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 benull
or empty. See the class-level documentation for theJSONObjectFilter
class for information about field path specifiers.filter
- The filter that will be matched against JSON objects contained in the specified field.
-
-
Method Detail
-
getField
@NotNull public java.util.List<java.lang.String> getField()
Retrieves the field path specifier for this filter.- Returns:
- The field path specifier for this filter.
-
setField
public void setField(@NotNull java.lang.String... field)
Sets the field path specifier for this filter.- Parameters:
field
- The field path specifier for this filter. It must not benull
or empty. See the class-level documentation for theJSONObjectFilter
class for information about field path specifiers.
-
setField
public void setField(@NotNull java.util.List<java.lang.String> field)
Sets the field path specifier for this filter.- Parameters:
field
- The field path specifier for this filter. It must not benull
or empty. See the class-level documentation for theJSONObjectFilter
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 benull
.
-
getFilterType
@NotNull public java.lang.String getFilterType()
Retrieves the value that must appear in thefilterType
field for this filter.- Specified by:
getFilterType
in classJSONObjectFilter
- Returns:
- The value that must appear in the
filterType
field for this filter.
-
getRequiredFieldNames
@NotNull protected java.util.Set<java.lang.String> getRequiredFieldNames()
Retrieves the names of all fields (excluding thefilterType
field) that must be present in the JSON object representing a filter of this type.- Specified by:
getRequiredFieldNames
in classJSONObjectFilter
- 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 java.util.Set<java.lang.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 classJSONObjectFilter
- 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 classJSONObjectFilter
- Parameters:
o
- The JSON object for which to make the determination.- Returns:
true
if this JSON object filter matches the provided JSON object, orfalse
if not.
-
toJSONObject
@NotNull public JSONObject toJSONObject()
Retrieves a JSON object that represents this filter.- Specified by:
toJSONObject
in classJSONObjectFilter
- Returns:
- A JSON object that represents 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 classJSONObjectFilter
- 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.
-
-