Metrics Engine Documentation Index
Configuration Reference Home

Result Criteria

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.

Note: this is an abstract component that cannot be instantiated.

Result Criteria define sets of criteria for grouping and describing operation results based on a number of properties, including properties of the associated client connection and operation request, the result code, response controls, privileges missing or used, and other operation-specific items.

Each operation result may be associated with zero or more Result Criteria, and server components may use Result Criteria to indicate which operation results should be processed and what kind of processing should be performed (e.g., to select operations for filtered logging or change notification).

Direct Subcomponents
Relations From this Component
Properties
dsconfig Usage

Direct Subcomponents

The following Result Criteria are available in the server :

These Result Criteria inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Result Criteria:

Properties

The properties supported by this managed object are as follows:


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

Basic Properties

description

Description
A description for this Result Criteria
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

java-class (Read-Only)

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


dsconfig Usage

To list the configured Result Criteria:

dsconfig list-result-criteria
     [--property {propertyName}] ...

To view the configuration for an existing Result Criteria:

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

To update the configuration for an existing Result Criteria:

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

To delete an existing Result Criteria:

dsconfig delete-result-criteria
     --criteria-name {name}