001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import java.util.SortedSet;
021import org.forgerock.opendj.config.Configuration;
022import org.forgerock.opendj.config.server.ConfigurationChangeListener;
023
024
025
026/**
027 * A server-side interface for querying Alert Handler settings.
028 * <p>
029 * Alert Handlers are used to notify administrators of significant
030 * problems or notable events that occur in the OpenDJ directory
031 * server.
032 */
033public interface AlertHandlerCfg extends Configuration {
034
035  /**
036   * Gets the configuration class associated with this Alert Handler.
037   *
038   * @return Returns the configuration class associated with this Alert Handler.
039   */
040  Class<? extends AlertHandlerCfg> configurationClass();
041
042
043
044  /**
045   * Register to be notified when this Alert Handler is changed.
046   *
047   * @param listener
048   *          The Alert Handler configuration change listener.
049   */
050  void addChangeListener(ConfigurationChangeListener<AlertHandlerCfg> listener);
051
052
053
054  /**
055   * Deregister an existing Alert Handler configuration change listener.
056   *
057   * @param listener
058   *          The Alert Handler configuration change listener.
059   */
060  void removeChangeListener(ConfigurationChangeListener<AlertHandlerCfg> listener);
061
062
063
064  /**
065   * Gets the "disabled-alert-type" property.
066   * <p>
067   * Specifies the names of the alert types that are disabled for this
068   * alert handler.
069   * <p>
070   * If there are any values for this attribute, then no alerts with
071   * any of the specified types are allowed. If there are no values for
072   * this attribute, then only alerts with a type included in the set
073   * of enabled alert types are allowed, or if there are no values for
074   * the enabled alert types option, then all alert types are allowed.
075   *
076   * @return Returns an unmodifiable set containing the values of the "disabled-alert-type" property.
077   */
078  SortedSet<String> getDisabledAlertType();
079
080
081
082  /**
083   * Gets the "enabled" property.
084   * <p>
085   * Indicates whether the Alert Handler is enabled.
086   *
087   * @return Returns the value of the "enabled" property.
088   */
089  boolean isEnabled();
090
091
092
093  /**
094   * Gets the "enabled-alert-type" property.
095   * <p>
096   * Specifies the names of the alert types that are enabled for this
097   * alert handler.
098   * <p>
099   * If there are any values for this attribute, then only alerts with
100   * one of the specified types are allowed (unless they are also
101   * included in the disabled alert types). If there are no values for
102   * this attribute, then any alert with a type not included in the
103   * list of disabled alert types is allowed.
104   *
105   * @return Returns an unmodifiable set containing the values of the "enabled-alert-type" property.
106   */
107  SortedSet<String> getEnabledAlertType();
108
109
110
111  /**
112   * Gets the "java-class" property.
113   * <p>
114   * Specifies the fully-qualified name of the Java class that
115   * provides the Alert Handler implementation.
116   *
117   * @return Returns the value of the "java-class" property.
118   */
119  String getJavaClass();
120
121}