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 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.
Scripted Change Subscription Handler provide change subscription handler implementations defined in a dynamically-loaded script which implements the ScriptedChangeSubscriptionHandler class defined in the UnboundID server SDK.
The following Scripted Change Subscription Handlers are available in the server :
These Scripted Change Subscription Handlers inherit from the properties described below.
The Scripted Change Subscription Handler component inherits from the Change Subscription Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| change-subscription | |
| script-argument |
| Description | A description for this Change Subscription 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 this change subscription handler is enabled within 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 set of change subscriptions for which this change subscription handler should be notified. If no values are provided then it will be notified for all change subscriptions defined in the server. |
| Default Value | This change subscription handler will be notified of changes matching any change subscription defined in the server. |
| Allowed Values | The DN of any Change Subscription. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of arguments used to customize the behavior for the Scripted Change Subscription Handler. Each configuration property should be given in the form 'name=value'. |
| Default Value | None |
| Allowed Values | An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Change Subscription Handlers:
dsconfig list-change-subscription-handlers
[--property {propertyName}] ...
To view the configuration for an existing Change Subscription Handler:
dsconfig get-change-subscription-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Change Subscription Handler:
dsconfig set-change-subscription-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Change Subscription Handler:
dsconfig delete-change-subscription-handler
--handler-name {name}