Configuration Reference Home
OpenDS - Account Status Notification Handler

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

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 :




This page describes the Account Status Notification Handler:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ enabled  None
↓ java-class

Basic Properties

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
Advanced Property
No
Read-only
No

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Account Status Notification Handler implementation.
Default Value
None
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.AccountStatusNotificationHandler
Multi-valued
No
Required
Yes
Admin Action Required
The Account Status Notification Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=Account Status Notification Handlers,cn=config
objectclass name
ds-cfg-account-status-notification-handler
objectclass superior
top

Property
LDAP attribute
enabled
ds-cfg-enabled
java-class
ds-cfg-java-class