Identity Data Store Documentation Index
Configuration Reference Home

Groovy Scripted Account Status Notification Handler

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
↓ 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

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}