Class ContainsFieldJSONObjectFilter
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
-
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.ContainsFieldJSONObjectFilter
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ContainsFieldJSONObjectFilter extends JSONObjectFilter
This class provides an implementation of a JSON object filter that can be used to identify JSON objects containing a specified field, optionally restricting it by the data type of the value.
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 a "contains field" 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
.
-
expectedType
-- Specifies the expected data type for the value of the target field. If this is not specified, then any data type will be permitted. If this is specified, then the filter will only match a JSON object that contains the specifiedfieldName
if its value has the expected data type. The value of theexpectedType
field must be either a single string or an array of strings, and the only values allowed will be:-
boolean
-- Indicates that the value may be a Boolean value oftrue
orfalse
. -
empty-array
-- Indicates that the value may be an empty array. -
non-empty-array
-- Indicates that the value may be an array that contains at least one element. There will not be any constraints placed on the values inside of the array. -
null
-- Indicates that the value may benull
. -
number
-- Indicates that the value may be a number. -
object
-- Indicates that the value may be a JSON object. -
string
-- Indicates that the value may be a string.
-
Examples
The following is an example of a "contains field" filter that will match any JSON object that includes a top-level field of "department" with any kind of value:{ "filterType" : "containsField", "field" : "department" }
The above filter can be created with the code:ContainsFieldJSONObjectFilter filter = new ContainsFieldJSONObjectFilter("department");
The following is an example of a "contains field" filter that will match any JSON object with a top-level field of "first" whose value is a JSON object (or an array containing a JSON object) with a field named "second" whose value is a Boolean of eithertrue
orfalse
.{ "filterType" : "containsField", "field" : [ "first", "second" ], "expectedType" : "boolean" }
The above filter can be created with the code:ContainsFieldJSONObjectFilter filter = new ContainsFieldJSONObjectFilter( Arrays.asList("first", "second"), EnumSet.of(ExpectedValueType.BOOLEAN));
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FIELD_EXPECTED_TYPE
The name of the JSON field that is used to specify the expected data type for the target field.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
FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents a "contains field" 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 ContainsFieldJSONObjectFilter(java.lang.String... field)
Creates a new "contains field" filter that targets the specified field.ContainsFieldJSONObjectFilter(java.util.List<java.lang.String> field)
Creates a new "contains field" filter that targets the specified field.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ContainsFieldJSONObjectFilter
decodeFilter(JSONObject filterObject)
Decodes the provided JSON object as a filter of this type.java.util.Set<ExpectedValueType>
getExpectedType()
Retrieves the set of acceptable value types for the specified field.java.util.List<java.lang.String>
getField()
Retrieves the field path specifier for this filter.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
setExpectedType(ExpectedValueType... expectedTypes)
Specifies the set of acceptable value types for the specified field.void
setExpectedType(java.util.Collection<ExpectedValueType> expectedTypes)
Specifies the set of acceptable value types for the specified field.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.JSONObject
toJSONObject()
Retrieves a JSON object that represents this filter.JSONObject
toNormalizedJSONObject()
Retrieves a JSON object that represents a normalized version of this filter.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toNormalizedString, toNormalizedString, 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 a "contains field" 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_EXPECTED_TYPE
@NotNull public static final java.lang.String FIELD_EXPECTED_TYPE
The name of the JSON field that is used to specify the expected data type for the target field.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContainsFieldJSONObjectFilter
public ContainsFieldJSONObjectFilter(@NotNull java.lang.String... field)
Creates a new "contains field" filter that targets the specified field.- 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.
-
ContainsFieldJSONObjectFilter
public ContainsFieldJSONObjectFilter(@NotNull java.util.List<java.lang.String> field)
Creates a new "contains field" filter that targets the specified field.- 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.
-
-
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.
-
getExpectedType
@NotNull public java.util.Set<ExpectedValueType> getExpectedType()
Retrieves the set of acceptable value types for the specified field.- Returns:
- The set of acceptable value types for the specified field.
-
setExpectedType
public void setExpectedType(@Nullable ExpectedValueType... expectedTypes)
Specifies the set of acceptable value types for the specified field.- Parameters:
expectedTypes
- The set of acceptable value types for the specified field. It may benull
or empty if the field may have a value of any type.
-
setExpectedType
public void setExpectedType(@Nullable java.util.Collection<ExpectedValueType> expectedTypes)
Specifies the set of acceptable value types for the specified field.- Parameters:
expectedTypes
- The set of acceptable value types for the specified field. It may benull
or empty if the field may have a value of any type.
-
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.
-
toNormalizedJSONObject
@NotNull public JSONObject toNormalizedJSONObject()
Retrieves a JSON object that represents a normalized version of this filter.- Specified by:
toNormalizedJSONObject
in classJSONObjectFilter
- Returns:
- A JSON object that represents a normalized version of this filter.
-
decodeFilter
@NotNull protected ContainsFieldJSONObjectFilter 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.
-
-