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 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2013-2015 ForgeRock AS
026 */
027package org.opends.server.api;
028
029
030
031import java.util.Map;
032
033import 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)
048public 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  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  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  Map<String, String> getAlerts();
084}
085