Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The Third Party Proxied Extended Operation Handler provides a Server SDK extension that may be used to customize the way that the Directory Proxy Server may forward an extended request to one or more backend servers. The extension will be responsible for selecting which server(s) should receive the request, and, if the request is to be processed by multiple servers, aggregating the results into a single result to return to the client.
↓Parent Component
↓Properties
↓dsconfig Usage
The Third Party Proxied Extended Operation Handler component inherits from the Extended Operation Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ route-to-backend-set-behavior |
| ↓ enabled | |
| ↓ extension-class | |
| ↓ extension-argument |
| Description | A description for this Extended Operation Handler |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server). |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The fully-qualified name of the Java class providing the logic for the Third Party Proxied Extended Operation Handler. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.proxy.api.ProxiedExtendedOperationHandler |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of arguments used to customize the behavior for the Third Party Proxied Extended Operation Handler. 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 |
route-to-backend-set-behavior (Advanced Property)
| Description | Specifies which request processors may process extended operations containing "route to backend set" request controls. |
| Default Value | named-request-processors-only |
| Allowed Values | named-request-processors-only - The operation is processed by each entry-balancing request processor named in a "route to backend set" request control, but is not processed by any other request processors, including proxying request processors that might otherwise have been used. all-request-processors - The operation may be processed by all request processors. The extended operation handler implementation determines whether the operation is actually processed by a request processor that was not named in a "route to backend set" request control. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Extended Operation Handlers:
dsconfig list-extended-operation-handlers
[--property {propertyName}] ...
To view the configuration for an existing Extended Operation Handler:
dsconfig get-extended-operation-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Extended Operation Handler:
dsconfig set-extended-operation-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Third Party Proxied Extended Operation Handler:
dsconfig create-extended-operation-handler
--handler-name {name}
--type third-party-proxied
--set enabled:{propertyValue}
--set extension-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Extended Operation Handler:
dsconfig delete-extended-operation-handler
--handler-name {name}