The JSON Schema Provider provides the ability to configure customized JSON query matching rules.
The core schema provides a default 'jsonQueryMatch' equality matching rule for JSON values which match JSON strings according to the LDAP 'caseIgnoreMatch' semantics (i.e trim white space and ignore case differences), as well as the indexing of all JSON fields. This schema provider allows users to create custom JSON matching rules which may use different string matching semantics and, more importantly, may only index a restricted set of JSON fields, thereby consuming less backend resources.
The JSON Schema object inherits from Schema Provider.
Use the --advanced option to access advanced properties.
Basic Properties
Advanced Properties
| Synopsis | Indicates whether JSON string comparisons should be case-sensitive. |
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | Indicates whether the Schema Provider is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | Indicates whether JSON string comparisons should ignore white-space. |
| Description | When enabled all leading and trailing white space will be removed and intermediate white space will be reduced to a single character. |
| Default Value | true |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | Specifies which JSON fields should be indexed. |
| Description | A field will be indexed if it matches any of the configured field patterns. |
| Default Value | All JSON fields will be indexed. |
| Allowed Values | A JSON pointer which may include wild-cards. A single '*' wild-card matches at most a single path element, whereas a double '**' matches zero or more path elements. |
| Multi-valued | Yes |
| Required | No |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | The name of the custom JSON matching rule. |
| Default Value | The matching rule will not have a name. |
| Allowed Values | A string. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | The numeric OID of the custom JSON matching rule. |
| Default Value | None |
| Allowed Values | The OID of the matching rule. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced | No |
| Read-Only | No |
| Synopsis | Specifies the fully-qualified name of the Java class that provides the JSON Schema implementation. |
| Default Value | org.opends.server.schema.JsonSchemaProvider |
| Allowed Values | A Java class that extends or implements: org.opends.server.schema.SchemaProvider |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced | Yes |
| Read-Only | No |