AccountStatusNotificationHandlerConfiguration.xml revision b1dce270ec218b8ad86ce6d745d295da038a5c88
<?xml version="1.0" encoding="utf-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! or http://forgerock.org/license/CDDLv1.0.html.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
!
! Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="account-status-notification-handler"
plural-name="account-status-notification-handlers"
package="org.opends.server.admin.std"
xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap"
xmlns:cli="http://www.opends.org/admin-cli">
<adm:synopsis>
<adm:user-friendly-plural-name />
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
<adm:user-friendly-name />
can be used to notify the user and/or administrators of the change.
</adm:synopsis>
<adm:tag name="user-management" />
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-account-status-notification-handler</ldap:name>
<ldap:superior>top</ldap:superior>
</ldap:object-class>
</adm:profile>
<adm:profile name="cli">
<cli:managed-object custom="true" />
</adm:profile>
<adm:property name="enabled" mandatory="true">
<adm:synopsis>
Indicates whether the
<adm:user-friendly-name />
is enabled. Only enabled handlers are invoked whenever
a related event occurs in the server.
</adm:synopsis>
<adm:syntax>
<adm:boolean />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-enabled</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
Specifies the fully-qualified name of the Java class that provides the
<adm:user-friendly-name />
implementation.
</adm:synopsis>
<adm:requires-admin-action>
<adm:component-restart />
</adm:requires-admin-action>
<adm:syntax>
<adm:java-class>
<adm:instance-of>
org.opends.server.api.AccountStatusNotificationHandler
</adm:instance-of>
</adm:java-class>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-java-class</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
</adm:managed-object>