001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.server;
027
028
029
030import org.opends.server.admin.Configuration;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035/**
036 * A server-side interface for querying Account Status Notification
037 * Handler settings.
038 * <p>
039 * Account Status Notification Handlers are invoked to provide
040 * notification to users in some form (for example, by an email
041 * message) when the status of a user's account has changed in some
042 * way. The Account Status Notification Handler can be used to notify
043 * the user and/or administrators of the change.
044 */
045public interface AccountStatusNotificationHandlerCfg extends Configuration {
046
047  /**
048   * Gets the configuration class associated with this Account Status Notification Handler.
049   *
050   * @return Returns the configuration class associated with this Account Status Notification Handler.
051   */
052  Class<? extends AccountStatusNotificationHandlerCfg> configurationClass();
053
054
055
056  /**
057   * Register to be notified when this Account Status Notification Handler is changed.
058   *
059   * @param listener
060   *          The Account Status Notification Handler configuration change listener.
061   */
062  void addChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener);
063
064
065
066  /**
067   * Deregister an existing Account Status Notification Handler configuration change listener.
068   *
069   * @param listener
070   *          The Account Status Notification Handler configuration change listener.
071   */
072  void removeChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener);
073
074
075
076  /**
077   * Gets the "enabled" property.
078   * <p>
079   * Indicates whether the Account Status Notification Handler is
080   * enabled. Only enabled handlers are invoked whenever a related
081   * event occurs in the server.
082   *
083   * @return Returns the value of the "enabled" property.
084   */
085  boolean isEnabled();
086
087
088
089  /**
090   * Gets the "java-class" property.
091   * <p>
092   * Specifies the fully-qualified name of the Java class that
093   * provides the Account Status Notification Handler implementation.
094   *
095   * @return Returns the value of the "java-class" property.
096   */
097  String getJavaClass();
098
099}