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.
Third Party Notification Managers provide notification manager implementations created in third-party code using the UnboundID server SDK.
A notification manager has one or more notification destinations which determine where notifications are to be delivered. Each notification destination has one or more notification subscriptions which determine which changes should result in a notification for that destination. Destinations and subscriptions each have associated details whose syntax is specific to the notification manager implementation.
Notification subscriptions are managed using the following LDAP extended operations:
The Third Party Notification Manager component inherits from the Notification Manager
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | monitor-entries-enabled |
| enabled | |
| subscription-base-dn | |
| transaction-notification | |
| extension-class | |
| extension-argument |
| Description | A description for this Notification Manager |
| 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 Notification Manager 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 | Specifies the DN of the entry below which subscription data is stored for this Notification Manager. This needs to be in the backend that has the data to be notified on, and must not be the same entry as the backend base DN. The subscription base DN entry does not need to exist as it will be created by the server. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies how the operations in an external transaction (e.g. a multi-update extended operation or an LDAP transaction) are notified for this Notification Manager. By default, each operation in an external transaction is treated individually such that a separate notification is delivered for each matched operation. Alternatively, a single notification can be delivered for each transaction containing one or more matched operations, in which case the notification can include all operations in the transaction, or just the operations that were matched. |
| Default Value | individual |
| Allowed Values | individual - A separate notification is delivered for each matched operation. matched-operations - All matched operations in a transaction are included in a single notification. all-operations - All operations in a transaction are included in a single notification. |
| 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 Notification Manager. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.ds.api.NotificationManager |
| 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 Notification Manager. 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 |
To list the configured Notification Managers:
dsconfig list-notification-managers
[--property {propertyName}] ...
To view the configuration for an existing Notification Manager:
dsconfig get-notification-manager-prop
--manager-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Notification Manager:
dsconfig set-notification-manager-prop
--manager-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Third Party Notification Manager:
dsconfig create-notification-manager
--manager-name {name}
--type third-party
--set enabled:{propertyValue}
--set subscription-base-dn:{propertyValue}
--set extension-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Notification Manager:
dsconfig delete-notification-manager
--manager-name {name}