Groovy Scripted Account Status Notification Handler

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.

Groovy Scripted Account Status Notification Handlers provide account status notification handler implementations defined in a dynamically-loaded Groovy script which implements the ScriptedAccountStatusNotificationHandler class defined in the UnboundID Server SDK.

Parent Component Properties dsconfig Usage

Parent Component

The Groovy Scripted Account Status Notification Handler component inherits from the Scripted Account Status Notification Handler

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 enabled
 asynchronous
 account-authentication-notification-result-criteria
 account-creation-notification-request-criteria
 account-deletion-notification-request-criteria
 account-update-notification-request-criteria
 script-argument
 script-class

Basic Properties

description

Description
A description for this Account Status Notification Handler
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

asynchronous

Description
Indicates whether the server should attempt to invoke this Account Status Notification Handler in a background thread so that any potentially-expensive processing (e.g., performing network communication to deliver a message) will not delay processing for the operation that triggered the notification.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

account-authentication-notification-result-criteria

Description
A result criteria object that identifies which successful bind operations should result in account authentication notifications for this handler. If this is not defined, then account authentication notifications will not be processed by this account status notification handler. If it is defined, then account authentication notifications will only be handled for successful bind operations that match the provided criteria.
Default Value
Account authentication notifications will not be processed by this account status notification handler.
Allowed Values
The DN of any Result Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

account-creation-notification-request-criteria

Description
A request criteria object that identifies which add requests should result in account creation notifications for this handler. If this is not defined, then account creation notifications will not be processed by this account status notification handler. If it is defined, then account creation notifications will only be handled for add requests that match the provided criteria.
Default Value
Account creation notifications will not be processed by this account status notification handler.
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

account-deletion-notification-request-criteria

Description
A request criteria object that identifies which delete requests should result in account deletion notifications for this handler. If this is not defined, then account deletion notifications will not be processed by this account status notification handler. If it is defined, then account deletion notifications will only be handled for delete requests that match the provided criteria.
Default Value
Account deletion notifications will not be processed by this account status notification handler.
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

account-update-notification-request-criteria

Description
A request criteria object that identifies which modify and modify DN requests should result in account update notifications for this handler. If this is not defined, then account update notifications will not be processed by this account status notification handler. If it is defined, then account update notifications will only be handled for modify and modify DN requests that match the provided criteria.
Default Value
Account update notifications will not be processed by this account status notification handler.
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

script-argument

Description
The set of arguments used to customize the behavior for the Scripted Account Status Notification 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

script-class

Description
The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Account Status Notification Handler.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Account Status Notification Handlers:

dsconfig list-account-status-notification-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Account Status Notification Handler:

dsconfig get-account-status-notification-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Account Status Notification Handler:

dsconfig set-account-status-notification-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Groovy Scripted Account Status Notification Handler:

dsconfig create-account-status-notification-handler
     --handler-name {name}
     --type groovy
     --set enabled:{propertyValue}
     --set script-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Account Status Notification Handler:

dsconfig delete-account-status-notification-handler
     --handler-name {name}