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 java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032import org.opends.server.admin.std.meta.ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType;
033
034
035
036/**
037 * A server-side interface for querying Error Log Account Status
038 * Notification Handler settings.
039 * <p>
040 * The Error Log Account Status Notification Handler is a notification
041 * handler that writes information to the server error log whenever an
042 * appropriate account status event occurs.
043 */
044public interface ErrorLogAccountStatusNotificationHandlerCfg extends AccountStatusNotificationHandlerCfg {
045
046  /**
047   * Gets the configuration class associated with this Error Log Account Status Notification Handler.
048   *
049   * @return Returns the configuration class associated with this Error Log Account Status Notification Handler.
050   */
051  Class<? extends ErrorLogAccountStatusNotificationHandlerCfg> configurationClass();
052
053
054
055  /**
056   * Register to be notified when this Error Log Account Status Notification Handler is changed.
057   *
058   * @param listener
059   *          The Error Log Account Status Notification Handler configuration change listener.
060   */
061  void addErrorLogChangeListener(ConfigurationChangeListener<ErrorLogAccountStatusNotificationHandlerCfg> listener);
062
063
064
065  /**
066   * Deregister an existing Error Log Account Status Notification Handler configuration change listener.
067   *
068   * @param listener
069   *          The Error Log Account Status Notification Handler configuration change listener.
070   */
071  void removeErrorLogChangeListener(ConfigurationChangeListener<ErrorLogAccountStatusNotificationHandlerCfg> listener);
072
073
074
075  /**
076   * Gets the "account-status-notification-type" property.
077   * <p>
078   * Indicates which types of event can trigger an account status
079   * notification.
080   *
081   * @return Returns an unmodifiable set containing the values of the "account-status-notification-type" property.
082   */
083  SortedSet<AccountStatusNotificationType> getAccountStatusNotificationType();
084
085
086
087  /**
088   * Gets the "java-class" property.
089   * <p>
090   * Specifies the fully-qualified name of the Java class that
091   * provides the Error Log Account Status Notification Handler
092   * implementation.
093   *
094   * @return Returns the value of the "java-class" property.
095   */
096  String getJavaClass();
097
098}