@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ObjectMatchesJSONObjectFilter extends JSONObjectFilter
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.
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.
{ "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")));
Modifier and Type | Field and 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.
|
FIELD_FILTER_TYPE, JSON_OBJECT_FILTER_MATCHING_RULE_NAME, JSON_OBJECT_FILTER_MATCHING_RULE_OID
Constructor and Description |
---|
ObjectMatchesJSONObjectFilter(java.util.List<java.lang.String> field,
JSONObjectFilter filter)
Creates a new instance of this filter type with the provided information.
|
ObjectMatchesJSONObjectFilter(java.lang.String field,
JSONObjectFilter filter)
Creates a new instance of this filter type with the provided information.
|
Modifier and Type | Method and 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 the
filterType 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 the
filterType 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.util.List<java.lang.String> field)
Sets the field path specifier for this filter.
|
void |
setField(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.
|
JSONObject |
toNormalizedJSONObject()
Retrieves a JSON object that represents a normalized version of this
filter.
|
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toNormalizedString, toNormalizedString, toString, toString
@NotNull public static final java.lang.String FILTER_TYPE
@NotNull public static final java.lang.String FIELD_FIELD_PATH
@NotNull public static final java.lang.String FIELD_FILTER
public ObjectMatchesJSONObjectFilter(@NotNull java.lang.String field, @NotNull JSONObjectFilter filter)
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.public ObjectMatchesJSONObjectFilter(@NotNull java.util.List<java.lang.String> field, @NotNull JSONObjectFilter filter)
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.@NotNull public java.util.List<java.lang.String> getField()
public void setField(@NotNull java.lang.String... field)
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.public void setField(@NotNull java.util.List<java.lang.String> field)
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.@NotNull public JSONObjectFilter getFilter()
public void setFilter(@NotNull JSONObjectFilter filter)
filter
- The filter that will be matched against any JSON objects
contained in the value of the specified field. It must
not be null
.@NotNull public java.lang.String getFilterType()
filterType
field for
this filter.getFilterType
in class JSONObjectFilter
filterType
field for
this filter.@NotNull protected java.util.Set<java.lang.String> getRequiredFieldNames()
filterType
field)
that must be present in the JSON object representing a filter of this type.getRequiredFieldNames
in class JSONObjectFilter
filterType
field)
that must be present in the JSON object representing a filter of
this type.@NotNull protected java.util.Set<java.lang.String> getOptionalFieldNames()
getOptionalFieldNames
in class JSONObjectFilter
public boolean matchesJSONObject(@NotNull JSONObject o)
matchesJSONObject
in class JSONObjectFilter
o
- The JSON object for which to make the determination.true
if this JSON object filter matches the provided JSON
object, or false
if not.@NotNull public JSONObject toJSONObject()
toJSONObject
in class JSONObjectFilter
@NotNull public JSONObject toNormalizedJSONObject()
toNormalizedJSONObject
in class JSONObjectFilter
@NotNull protected ObjectMatchesJSONObjectFilter decodeFilter(@NotNull JSONObject filterObject) throws JSONException
decodeFilter
in class JSONObjectFilter
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.JSONException
- If the provided JSON object cannot be decoded as a
valid filter of this type.