Identity Data Store Documentation Index
Configuration Reference Home

Account Status Notification Handler

Note: this is an abstract component that cannot be instantiated.

Account Status Notification Handlers are invoked to provide notification to users in some form (for example, by an email message) when the status of a user's account has changed in some way. The Account Status Notification Handler can be used to notify the user and/or administrators of the change.

↓Direct Subcomponents
↓Relations to This Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Account Status Notification Handlers are available in the server :

These Account Status Notification Handlers inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Account Status Notification Handlers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-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

java-class (Read-Only)

Description
Specifies the fully-qualified name of the Java class that provides the Account Status Notification Handler implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.AccountStatusNotificationHandler
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 delete an existing Account Status Notification Handler:

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