Package org.forgerock.opendj.server.config.meta

Class JsonQueryEqualityMatchingRuleCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<JsonQueryEqualityMatchingRuleCfgClient,JsonQueryEqualityMatchingRuleCfg>

org.forgerock.opendj.server.config.meta.JsonQueryEqualityMatchingRuleCfgDefn

public final class JsonQueryEqualityMatchingRuleCfgDefn
extends ManagedObjectDefinition<JsonQueryEqualityMatchingRuleCfgClient,JsonQueryEqualityMatchingRuleCfg>

An interface for querying the JSON Query Equality Matching Rule managed object definition meta information.

The JSON Query Equality Matching Rule Provider provides the ability to configure customized JSON query equality matching rules.

Method Summary

Modifier and Type	Method	Description
JsonQueryEqualityMatchingRuleCfgClient	createClientConfiguration(ManagedObject<? extends JsonQueryEqualityMatchingRuleCfgClient> impl)	Creates a client configuration view of the provided managed object.
JsonQueryEqualityMatchingRuleCfg	createServerConfiguration(ServerManagedObject<? extends JsonQueryEqualityMatchingRuleCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getCaseSensitiveStringsPropertyDefinition()	Get the "case-sensitive-strings" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
BooleanPropertyDefinition	getIgnoreWhiteSpacePropertyDefinition()	Get the "ignore-white-space" property definition.
StringPropertyDefinition	getIndexedFieldPropertyDefinition()	Get the "indexed-field" property definition.
static JsonQueryEqualityMatchingRuleCfgDefn	getInstance()	Get the JSON Query Equality Matching Rule configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getMatchingRuleNamePropertyDefinition()	Get the "matching-rule-name" property definition.
StringPropertyDefinition	getMatchingRuleOidPropertyDefinition()	Get the "matching-rule-oid" property definition.
Class<JsonQueryEqualityMatchingRuleCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static JsonQueryEqualityMatchingRuleCfgDefn getInstance()

Get the JSON Query Equality Matching Rule configuration definition singleton.

Returns:

Returns the JSON Query Equality Matching Rule configuration definition singleton.

createClientConfiguration

public JsonQueryEqualityMatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends JsonQueryEqualityMatchingRuleCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<JsonQueryEqualityMatchingRuleCfgClient,JsonQueryEqualityMatchingRuleCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public JsonQueryEqualityMatchingRuleCfg createServerConfiguration(ServerManagedObject<? extends JsonQueryEqualityMatchingRuleCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<JsonQueryEqualityMatchingRuleCfgClient,JsonQueryEqualityMatchingRuleCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<JsonQueryEqualityMatchingRuleCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<JsonQueryEqualityMatchingRuleCfgClient,JsonQueryEqualityMatchingRuleCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getCaseSensitiveStringsPropertyDefinition

public BooleanPropertyDefinition getCaseSensitiveStringsPropertyDefinition()

Get the "case-sensitive-strings" property definition.

Indicates whether JSON string comparisons should be case-sensitive.

Returns:

Returns the "case-sensitive-strings" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the JSON Query Equality Matching Rule is enabled for use.

Returns:

Returns the "enabled" property definition.

getIgnoreWhiteSpacePropertyDefinition

public BooleanPropertyDefinition getIgnoreWhiteSpacePropertyDefinition()

Get the "ignore-white-space" property definition.

Indicates whether JSON string comparisons should ignore white-space.

When enabled all leading and trailing white space will be removed and intermediate white space will be reduced to a single character.

Returns:

Returns the "ignore-white-space" property definition.

getIndexedFieldPropertyDefinition

public StringPropertyDefinition getIndexedFieldPropertyDefinition()

Get the "indexed-field" property definition.

Specifies which JSON fields should be indexed.

A field will be indexed if it matches any of the configured field patterns.

Returns:

Returns the "indexed-field" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the JSON Query Equality Matching Rule implementation.

Returns:

Returns the "java-class" property definition.

getMatchingRuleNamePropertyDefinition

public StringPropertyDefinition getMatchingRuleNamePropertyDefinition()

Get the "matching-rule-name" property definition.

The name of the custom JSON matching rule.

Returns:

Returns the "matching-rule-name" property definition.

getMatchingRuleOidPropertyDefinition

public StringPropertyDefinition getMatchingRuleOidPropertyDefinition()

Get the "matching-rule-oid" property definition.

The numeric OID of the custom JSON matching rule.

Returns:

Returns the "matching-rule-oid" property definition.