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