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.
Search Reference Criteria define sets of criteria for grouping and describing search result references based on a number of properties, including properties of the associated client connection and operation request, the reference contents, and included controls.
Each search result reference may be associated with zero or more Search Reference Criteria, and server components may use Search Reference Criteria to indicate which search result references should be processed and what kind of processing should be performed (e.g., to select references for filtered logging).
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Search Reference Criteria are available in the server :
These Search Reference Criteria inherit from the properties described below.
The following components have a direct aggregation relation to Search Reference Criteria:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ java-class |
| Description | A description for this Search Reference Criteria |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The fully-qualified name of the Java class that provides the logic for this search reference criteria implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.SearchReferenceCriteria |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Search Reference Criteria:
dsconfig list-search-reference-criteria
[--property {propertyName}] ...
To view the configuration for an existing Search Reference Criteria:
dsconfig get-search-reference-criteria-prop
--criteria-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Search Reference Criteria:
dsconfig set-search-reference-criteria-prop
--criteria-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Search Reference Criteria:
dsconfig delete-search-reference-criteria
--criteria-name {name}