org.forgerock.opendj.rest2ldap.schema

Class JsonSchema

java.lang.Object

org.forgerock.opendj.rest2ldap.schema.JsonSchema

public final class JsonSchema
extends Object

Utility methods for obtaining JSON syntaxes and matching rules. See the package documentation for more detail.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonSchema.ValidationPolicy JSON value validation policies.

Field Summary

Fields

Modifier and Type	Field and Description
static Option<Boolean>	CASE_SENSITIVE_STRINGS Matching rule option controlling whether JSON string comparisons should be case-sensitive.
static Option<Boolean>	IGNORE_WHITE_SPACE Matching rule option controlling whether JSON string comparisons should ignore white-space.
static Option<Collection<String>>	INDEXED_FIELD_PATTERNS Matching rule option controlling which JSON fields should be indexed by the matching rule.
static Option<JsonSchema.ValidationPolicy>	VALIDATION_POLICY Schema option controlling syntax validation for JSON based attributes.

Method Summary

Modifier and Type	Method and Description
static SchemaBuilder	addJsonSyntaxesAndMatchingRulesToSchema(SchemaBuilder builder) Adds the syntaxes and matching rules required by for JSON attribute support to the provided schema builder.
static Object	byteStringToJson(ByteString value) Parses the provided byte string as a JSON value.
static MatchingRule	getCaseExactJsonIdMatchingRule() Returns the jsonMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.5.
static MatchingRule	getCaseExactJsonQueryMatchingRule() Returns the jsonQueryMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.2.
static String	getCaseIgnoreExtensibleJsonOrderingMatchingRule() Returns the extensible JSON ordering matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.6.
static MatchingRule	getCaseIgnoreJsonIdMatchingRule() Returns the jsonMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.4.
static MatchingRule	getCaseIgnoreJsonQueryMatchingRule() Returns the jsonQueryMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.1.
static Syntax	getJsonQuerySyntax() Returns the JSON Query attribute syntax having the OID 1.3.6.1.4.1.36733.2.1.3.2.
static Syntax	getJsonSyntax() Returns the JSON attribute syntax having the OID 1.3.6.1.4.1.36733.2.1.3.1.
static ByteString	jsonToByteString(Object value) Converts a JSON Object to a ByteString representation.
static MatchingRuleImpl	newJsonEqualityMatchingRuleImpl(Collection<JsonPointer> keys, Options options) Creates a new custom JSON equality matching rule implementation with the provided matching rule name and options.
static MatchingRuleImpl	newJsonOrderingMatchingRuleImpl(List<JsonPointer> keys, Options options) Creates a new custom JSON ordering matching rule implementation with the provided matching rule name and options.
static MatchingRuleImpl	newJsonQueryEqualityMatchingRuleImpl(String matchingRuleName, Options options) Creates a new custom JSON query equality matching rule implementation with the provided matching rule name and options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALIDATION_POLICY

public static final Option<JsonSchema.ValidationPolicy> VALIDATION_POLICY

Schema option controlling syntax validation for JSON based attributes. By default this compatibility option is set to JsonSchema.ValidationPolicy.STRICT.

CASE_SENSITIVE_STRINGS

public static final Option<Boolean> CASE_SENSITIVE_STRINGS

Matching rule option controlling whether JSON string comparisons should be case-sensitive. By default this compatibility option is set to false meaning that case will be ignored.

This option must be provided when constructing a JSON matching rule using newJsonQueryEqualityMatchingRuleImpl(java.lang.String, org.forgerock.util.Options), and cannot be overridden at the schema level.

IGNORE_WHITE_SPACE

public static final Option<Boolean> IGNORE_WHITE_SPACE

Matching rule option controlling whether JSON string comparisons should ignore white-space. By default this compatibility option is set to true meaning that leading and trailing white-space will be ignored and intermediate white-space will be reduced to a single white-space character.

This option must be provided when constructing a JSON matching rule using newJsonQueryEqualityMatchingRuleImpl(java.lang.String, org.forgerock.util.Options), and cannot be overridden at the schema level.

INDEXED_FIELD_PATTERNS

public static final Option<Collection<String>> INDEXED_FIELD_PATTERNS

Matching rule option controlling which JSON fields should be indexed by the matching rule. By default all fields will be indexed. To restrict the set of indexed fields specify a list whose values are wild-card patterns for matching against JSON pointers. Patterns are JSON pointers where "*" represents zero or more characters in a single path element, and "**" represents any number of path elements. For example:

Pattern examples

Pattern	Matches	Doesn't match
/aaa/bbb/ccc	/aaa/bbb/ccc	/aaa/bbb/ccc/ddd /aaa/bbb/cccc
/aaa/b*/ccc	/aaa/bbb/ccc /aaa/bxx/ccc	/aaa/xxx/ccc /aaa/bbb
/aaa/**/ddd	/aaa/ddd /aaa/xxx/yyy/ddd	/aaa/bbb/ccc
/aaa/**	/aaa /aaa/bbb /aaa/bbb/ccc	/aa

Method Detail

getJsonSyntax

public static Syntax getJsonSyntax()

Returns the JSON attribute syntax having the OID 1.3.6.1.4.1.36733.2.1.3.1. Attribute values of this syntax must be valid JSON. Use the VALIDATION_POLICY schema option to control the degree of syntax enforcement. By default JSON attributes will support equality matching using the jsonQueryMatch matching rule, although this may be overridden when defining individual attribute types.

Returns:

The JSON attribute syntax having the OID 1.3.6.1.4.1.36733.2.1.3.1.

getJsonQuerySyntax

public static Syntax getJsonQuerySyntax()

Returns the JSON Query attribute syntax having the OID 1.3.6.1.4.1.36733.2.1.3.2. Attribute values of this syntax must be valid CREST JSON query filter strings as defined in QueryFilterParser.

Returns:

The JSON Query attribute syntax having the OID 1.3.6.1.4.1.36733.2.1.3.2.

getCaseIgnoreJsonIdMatchingRule

public static MatchingRule getCaseIgnoreJsonIdMatchingRule()

Returns the jsonMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.4. This matching rule will compare the _id member of JSON objects. If the _id member has a string value, the matching rule will use a case insensitive string comparison, and will ignore white space.

Returns:

The jsonMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.4.

getCaseExactJsonIdMatchingRule

public static MatchingRule getCaseExactJsonIdMatchingRule()

Returns the jsonMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.5. This matching rule will compare the _id member of JSON objects. If the _id member has a string value, the matching rule will use a case sensitive string comparison, and will ignore white space.

Returns:

The @code jsonMatch} matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.5.

getCaseIgnoreJsonQueryMatchingRule

public static MatchingRule getCaseIgnoreJsonQueryMatchingRule()

Returns the jsonQueryMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.1. The matching rule's assertion syntax is a CREST JSON query filter. This matching rule will ignore case when comparing JSON strings as well as ignoring white space. In addition, all JSON fields will be indexed if indexing is enabled.

Returns:

The jsonQueryMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.1.

getCaseExactJsonQueryMatchingRule

public static MatchingRule getCaseExactJsonQueryMatchingRule()

Returns the jsonQueryMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.2. The matching rule's assertion syntax is a CREST JSON query filter. This matching rule will check the case when comparing JSON strings as well as ignoring ignore white space. In addition, all JSON fields will be indexed if indexing is enabled.

Returns:

The jsonQueryMatch matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.2.

getCaseIgnoreExtensibleJsonOrderingMatchingRule

public static String getCaseIgnoreExtensibleJsonOrderingMatchingRule()

Returns the extensible JSON ordering matching rule having the OID 1.3.6.1.4.1.36733.2.1.4.6.

The returned string is expected to be concatenated with a colon (:) and the colon (:) separated list of the JSON pointers referencing the entries' fields which must be taken into consideration for the ordering.

Returns:

A string format to build an extensible ordering json matching rule.

newJsonEqualityMatchingRuleImpl

public static MatchingRuleImpl newJsonEqualityMatchingRuleImpl(Collection<JsonPointer> keys,
                                                               Options options)

Creates a new custom JSON equality matching rule implementation with the provided matching rule name and options.

Parameters:

keys - The list of JSON fields to use to normalize a JSON object.

options - The options controlling the behavior of the matching rule.

Returns:

The new custom JSON equality matching rule implementation.

See Also:

CASE_SENSITIVE_STRINGS, IGNORE_WHITE_SPACE

newJsonOrderingMatchingRuleImpl

public static MatchingRuleImpl newJsonOrderingMatchingRuleImpl(List<JsonPointer> keys,
                                                               Options options)

Creates a new custom JSON ordering matching rule implementation with the provided matching rule name and options.

Parameters:

keys - The list of JSON fields to use to normalize a JSON object.

options - The options controlling the behavior of the matching rule.

Returns:

The new custom JSON ordering matching rule implementation.

See Also:

CASE_SENSITIVE_STRINGS, IGNORE_WHITE_SPACE

newJsonQueryEqualityMatchingRuleImpl

public static MatchingRuleImpl newJsonQueryEqualityMatchingRuleImpl(String matchingRuleName,
                                                                    Options options)

Creates a new custom JSON query equality matching rule implementation with the provided matching rule name and options. This method should be used when creating custom JSON matching rules whose behavior differs from getCaseIgnoreJsonQueryMatchingRule().

Parameters:

matchingRuleName - The name of the matching rule. This will be used as the index ID in attribute indexes so it must not collide with other indexes identifiers.

options - The options controlling the behavior of the matching rule.

Returns:

The new custom JSON query equality matching rule implementation.

See Also:

CASE_SENSITIVE_STRINGS, IGNORE_WHITE_SPACE

addJsonSyntaxesAndMatchingRulesToSchema

public static SchemaBuilder addJsonSyntaxesAndMatchingRulesToSchema(SchemaBuilder builder)

Adds the syntaxes and matching rules required by for JSON attribute support to the provided schema builder.

Parameters:

builder - The schema builder to which the schema elements should be added.

Returns:

The schema builder.

byteStringToJson

public static Object byteStringToJson(ByteString value)

Parses the provided byte string as a JSON value. Invalid values will result in a LocalizedIllegalArgumentException.

Parameters:

value - The value to be parsed.

Returns:

The parsed JSON value.

Throws:

LocalizedIllegalArgumentException - If value is not valid JSON.

jsonToByteString

public static ByteString jsonToByteString(Object value)
                                   throws com.fasterxml.jackson.core.JsonProcessingException

Converts a JSON Object to a ByteString representation.

Parameters:

value - The JSON object to be converted.

Returns:

The ByteString representation.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - If conversion failed for some reason.