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 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.api;
028    
029    
030    
031    import java.util.LinkedHashMap;
032    
033    import org.opends.server.types.DN;
034    
035    
036    
037    /**
038     * This class defines an interface that may be used to define a set of
039     * alert notifications that may be generated by this Directory Server
040     * component.  The notifications will be made available through JMX
041     * and may be published through other mechanisms as well.
042     */
043    @org.opends.server.types.PublicAPI(
044         stability=org.opends.server.types.StabilityLevel.VOLATILE,
045         mayInstantiate=false,
046         mayExtend=true,
047         mayInvoke=false)
048    public interface AlertGenerator
049    {
050      /**
051       * Retrieves the DN of the configuration entry with which this alert
052       * generator is associated.
053       *
054       * @return  The DN of the configuration entry with which this alert
055       *          generator is associated.
056       */
057      public DN getComponentEntryDN();
058    
059    
060    
061      /**
062       * Retrieves the fully-qualified name of the Java class for this
063       * alert generator implementation.
064       *
065       * @return  The fully-qualified name of the Java class for this
066       *          alert generator implementation.
067       */
068      public String getClassName();
069    
070    
071    
072      /**
073       * Retrieves information about the set of alerts that this generator
074       * may produce.  The map returned should be between the notification
075       * type for a particular notification and the human-readable
076       * description for that notification.  This alert generator must not
077       * generate any alerts with types that are not contained in this
078       * list.
079       *
080       * @return  Information about the set of alerts that this generator
081       *          may produce.
082       */
083      public LinkedHashMap<String,String> getAlerts();
084    }
085