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