Identity Data Store Documentation Index
Configuration Reference Home

Ordering Matching Rule

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

Ordering Matching Rules define a set of rules for performing ordering matching operations against assertion values.

These matching rules are used for greater-than-or-equal and less-than-or-equal comparisons, as well as for sorting.

Parent Component
Properties
dsconfig Usage

Parent Component

The Ordering Matching Rule component inherits from the Matching Rule

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ enabled  None
↓ java-class

Basic Properties

enabled

Description
Indicates whether the Matching Rule is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

java-class (Read-Only)

Description
Specifies the fully-qualified name of the Java class that provides the Matching Rule implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.MatchingRule
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Matching Rules:

dsconfig list-matching-rules
     [--property {propertyName}] ...

To view the configuration for an existing Matching Rule:

dsconfig get-matching-rule-prop
     --rule-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Matching Rule:

dsconfig set-matching-rule-prop
     --rule-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Ordering Matching Rule:

dsconfig create-matching-rule
     --rule-name {name}
     --type ordering
     --set enabled:{propertyValue}
     --set java-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Matching Rule:

dsconfig delete-matching-rule
     --rule-name {name}