Metrics Engine Documentation Index
Configuration Reference Home

Third Party Search Reference 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.

Third Party Search Reference Criteria provide search reference criteria implementations created in third-party code using the UnboundID Server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Search Reference Criteria component inherits from the Search Reference Criteria

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ extension-class
↓ extension-argument

Basic Properties

description

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

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party Search Reference Criteria.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.ds.api.SearchReferenceCriteria
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Description
The set of arguments used to customize the behavior for the Third Party Search Reference Criteria. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

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 create a new Third Party Search Reference Criteria:

dsconfig create-search-reference-criteria
     --criteria-name {name}
     --type third-party
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Search Reference Criteria:

dsconfig delete-search-reference-criteria
     --criteria-name {name}