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 UnboundID support in order to understand the potential impact of that change.
Note: this is an abstract component that cannot be instantiated.
Change Subscription Handlers may be used to provide notification of changes that match one or more change subscriptions.
↓Direct Subcomponents
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following Change Subscription Handlers are available in the server :
These Change Subscription Handlers inherit from the properties described below.
The following components have a direct aggregation relation from Change Subscription Handlers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ java-class | |
| ↓ change-subscription |
| 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 fully-qualified name of the Java class that provides the change subscription handler implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.ChangeSubscriptionHandler |
| 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 |
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}