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