/*
|
* 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
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* 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
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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
|
*
|
*
|
* Portions Copyright 2006 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api;
|
|
|
|
import org.opends.server.config.ConfigEntry;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.core.InitializationException;
|
import org.opends.server.types.AccountStatusNotification;
|
import org.opends.server.types.AccountStatusNotificationType;
|
import org.opends.server.types.DN;
|
|
import static org.opends.server.loggers.Debug.*;
|
|
|
|
/**
|
* This class defines the set of methods that must be implemented for
|
* an account status notification handler. This handler will be
|
* invoked whenever certain types of events occur that could change
|
* the status of a user account. The account status notification
|
* handler may be used to notify the user and/or administrators of the
|
* change.
|
*/
|
public abstract class AccountStatusNotificationHandler
|
{
|
/**
|
* The fully-qualified name of this class for debugging purposes.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.api.AccountStatusNotificationHandler";
|
|
|
|
/**
|
* Initializes this account status notification handler based on the
|
* information in the provided configuration entry.
|
*
|
* @param configEntry The configuration entry that contains the
|
* information to use to initialize this
|
* account status notification handler.
|
*
|
* @throws ConfigException If the provided entry does not contain
|
* a valid configuration for this account
|
* status notification handler.
|
*
|
* @throws InitializationException If a problem occurs during
|
* initialization that is not
|
* related to the server
|
* configuration.
|
*/
|
public abstract void initializeStatusNotificationHandler(
|
ConfigEntry configEntry)
|
throws ConfigException, InitializationException;
|
|
|
|
/**
|
* Performs any finalization that may be necessary when this status
|
* notification handler is taken out of service.
|
*/
|
public void finalizeStatusNotificationHandler()
|
{
|
assert debugEnter(CLASS_NAME,
|
"finalizeStatusNotificationHandler");
|
|
// No action is required by default.
|
}
|
|
|
|
/**
|
* Performs any processing that may be necessary in conjunction with
|
* the provided account status notification type.
|
*
|
* @param notificationType The type for this account status
|
* notification.
|
* @param userDN The DN of the user entry to which this
|
* notification applies.
|
* @param messageID The unique ID for this notification.
|
* @param message The human-readable message for this
|
* notification.
|
*/
|
public abstract void
|
handleStatusNotification(
|
AccountStatusNotificationType notificationType,
|
DN userDN, int messageID, String message);
|
|
|
|
/**
|
* Performs any processing that may be necessary in conjunction with
|
* the provided account status notification.
|
*
|
* @param notification The account status notification to be
|
* processed.
|
*/
|
public void handleStatusNotification(
|
AccountStatusNotification notification)
|
{
|
assert debugEnter(CLASS_NAME, "handleStatusNotification",
|
String.valueOf(notification));
|
|
handleStatusNotification(notification.getNotificationType(),
|
notification.getUserDN(),
|
notification.getMessageID(),
|
notification.getMessage());
|
}
|
}
|
