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 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import java.util.SortedSet; 031import org.opends.server.admin.server.ConfigurationChangeListener; 032 033 034 035/** 036 * A server-side interface for querying SMTP Alert Handler settings. 037 * <p> 038 * The SMTP Alert Handler may be used to send e-mail messages to 039 * notify administrators of significant events that occur within the 040 * server. 041 */ 042public interface SMTPAlertHandlerCfg extends AlertHandlerCfg { 043 044 /** 045 * Gets the configuration class associated with this SMTP Alert Handler. 046 * 047 * @return Returns the configuration class associated with this SMTP Alert Handler. 048 */ 049 Class<? extends SMTPAlertHandlerCfg> configurationClass(); 050 051 052 053 /** 054 * Register to be notified when this SMTP Alert Handler is changed. 055 * 056 * @param listener 057 * The SMTP Alert Handler configuration change listener. 058 */ 059 void addSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener); 060 061 062 063 /** 064 * Deregister an existing SMTP Alert Handler configuration change listener. 065 * 066 * @param listener 067 * The SMTP Alert Handler configuration change listener. 068 */ 069 void removeSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener); 070 071 072 073 /** 074 * Gets the "java-class" property. 075 * <p> 076 * Specifies the fully-qualified name of the Java class that 077 * provides the SMTP Alert Handler implementation. 078 * 079 * @return Returns the value of the "java-class" property. 080 */ 081 String getJavaClass(); 082 083 084 085 /** 086 * Gets the "message-body" property. 087 * <p> 088 * Specifies the body that should be used for email messages 089 * generated by this alert handler. 090 * <p> 091 * The token "%%%%alert-type%%%%" is dynamically replaced with the 092 * alert type string. The token "%%%%alert-id%%%%" is dynamically 093 * replaced with the alert ID value. The token 094 * "%%%%alert-message%%%%" is dynamically replaced with the alert 095 * message. The token "\\n" is replaced with an end-of-line marker. 096 * 097 * @return Returns the value of the "message-body" property. 098 */ 099 String getMessageBody(); 100 101 102 103 /** 104 * Gets the "message-subject" property. 105 * <p> 106 * Specifies the subject that should be used for email messages 107 * generated by this alert handler. 108 * <p> 109 * The token "%%%%alert-type%%%%" is dynamically replaced with the 110 * alert type string. The token "%%%%alert-id%%%%" is dynamically 111 * replaced with the alert ID value. The token 112 * "%%%%alert-message%%%%" is dynamically replaced with the alert 113 * message. The token "\\n" is replaced with an end-of-line marker. 114 * 115 * @return Returns the value of the "message-subject" property. 116 */ 117 String getMessageSubject(); 118 119 120 121 /** 122 * Gets the "recipient-address" property. 123 * <p> 124 * Specifies an email address to which the messages should be sent. 125 * <p> 126 * Multiple values may be provided if there should be more than one 127 * recipient. 128 * 129 * @return Returns an unmodifiable set containing the values of the "recipient-address" property. 130 */ 131 SortedSet<String> getRecipientAddress(); 132 133 134 135 /** 136 * Gets the "sender-address" property. 137 * <p> 138 * Specifies the email address to use as the sender for messages 139 * generated by this alert handler. 140 * 141 * @return Returns the value of the "sender-address" property. 142 */ 143 String getSenderAddress(); 144 145}