ViewVC Help

View File | Revision Log | Show Annotations | Revision Graph | Root Listing

root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/client/alerters/EMail__Alerter.java

Comparing projects/cms/source/server/uk/org/iscream/cms/server/client/alerters/EMail__Alerter.java (file contents):
Revision 1.5 by tdb, Fri Mar 2 01:29:22 2001 UTC vs.
Revision 1.26 by tdb, Tue May 21 16:47:16 2002 UTC

#	Line 1 | Line 1
1	+	/*
2	+	* i-scream central monitoring system
3	+	* http://www.i-scream.org.uk
4	+	* Copyright (C) 2000-2002 i-scream
5	+	*
6	+	* This program is free software; you can redistribute it and/or
7	+	* modify it under the terms of the GNU General Public License
8	+	* as published by the Free Software Foundation; either version 2
9	+	* of the License, or (at your option) any later version.
10	+	*
11	+	* This program is distributed in the hope that it will be useful,
12	+	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	+	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14	+	* GNU General Public License for more details.
15	+	*
16	+	* You should have received a copy of the GNU General Public License
17	+	* along with this program; if not, write to the Free Software
18	+	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19	+	*/
20	+
21		//---PACKAGE DECLARATION---
22	<	package uk.ac.ukc.iscream.client.alerters;
22	>	package uk.org.iscream.cms.server.client.alerters;
23
24		//---IMPORTS---
25	<	import uk.ac.ukc.iscream.client.*;
26	<	import uk.ac.ukc.iscream.core.*;
27	<	import uk.ac.ukc.iscream.util.*;
28	<	import uk.ac.ukc.iscream.componentmanager.*;
9	<
10	<	import java.util.*;
25	>	import uk.org.iscream.cms.server.client.*;
26	>	import uk.org.iscream.cms.server.core.*;
27	>	import uk.org.iscream.cms.server.util.*;
28	>	import uk.org.iscream.cms.server.componentmanager.*;
29		import java.io.*;
30	+	import java.util.StringTokenizer;
31
32	+
33		/**
34	<	* This Alert sends by e-mail.
34	>	* This alerter delivers alerts using e-mail.
35		*
36		* @author  $Author$
37		* @version $Id$
38		*/
39	<	public class EMail__Alerter implements PluginAlerter {
39	>	public class EMail__Alerter extends AlerterSkeleton {
40
41		//---FINAL ATTRIBUTES---
42
#	Line 25 | Line 45 | public class EMail__Alerter implements PluginAlerter {
45		*/
46		public final String REVISION = "$Revision$";
47
48	<	public final String DESC = "Sends alerts by e-mail";
48	>	/**
49	>	* A description of this alerter
50	>	*/
51	>	public final String DESC = "Sends alerts over e-mail.";
52
53		//---STATIC METHODS---
54
55		//---CONSTRUCTORS---
56
34	–	public EMail__Alerter() {
35	–	// get the configuration for this alerter
36	–	Configuration config = ReferenceManager.getInstance().getCM().getConfiguration(_name);
37	–
38	–	// an integer value
39	–	_level = Integer.parseInt(config.getProperty("Alerter.EMail.level"));
40	–	// a semi-colon seperated list of destination addresses
41	–	_destList = config.getProperty("Alerter.EMail.destList");
42	–	// a single from address
43	–	_sender = config.getProperty("Alerter.EMail.sender");
44	–	// the fqdn of an smtp server
45	–	_smtpServer = config.getProperty("Alerter.EMail.smtpServer");
46	–	// a subject with the following: %level% and %message%
47	–	// eg, "i-scream e-mail alert: level %level%, %message%"
48	–	_subject = config.getProperty("Alerter.EMail.subject");
49	–	// a message body with the following: %level% and %message%
50	–	_message = config.getProperty("Alerter.EMail.message");
51	–
52	–	_logger.write(toString(), Logger.SYSINT, "IRC Alerter started");
53	–	}
54	–
57		//---PUBLIC METHODS---
58
59	+	/**
60	+	* Implements the abstract method from the skeleton class.
61	+	* This method will attempt to send an alert
62	+	* message using the configured email configuration.
63	+	*
64	+	* @param alert the alert to send
65	+	*/
66		public void sendAlert(Alert alert) {
67	<	// only send if it's equal (or above) our level
68	<	if(alert.getLevel() >= _level) {
69	<	// sort out the subject
70	<	String subject = _subject;
71	<	subject = StringUtils.replaceText(subject, "%level%", String.valueOf(alert.getLevel()));
72	<	subject = StringUtils.replaceText(subject, "%source%", alert.getSource());
73	<	subject = StringUtils.replaceText(subject, "%value%", alert.getValue());
74	<	subject = StringUtils.replaceText(subject, "%thresholdValue%", alert.getThresholdValue());
75	<	subject = StringUtils.replaceText(subject, "%attributeName%", alert.getAttributeName());
67	>	// get the subject and replace fields
68	>	String subject;
69	>	try {
70	>	subject = _cp.getProperty(_name, "Alerter.EMail.subject");
71	>	} catch (PropertyNotFoundException e) {
72	>	subject = NOT_CONFIGURED;
73	>	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.subject value unavailable using default of " + subject);
74	>	}
75	>	subject = processAlertMessage(subject, alert);
76	>
77	>	// get the message body and replace fields
78	>	String message;
79	>	try {
80	>	message = _cp.getProperty(_name, "Alerter.EMail.message");
81	>	} catch (PropertyNotFoundException e) {
82	>	message = NOT_CONFIGURED;
83	>	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.message value unavailable using default of " + message);
84	>	}
85	>	message = processAlertMessage(message, alert);
86	>
87	>	// attempt to send the actual message
88	>	try {
89	>	// create SMTP message
90	>	Smtp smtp = new Smtp(_cp.getProperty(_name, "Alerter.EMail.smtpServer"));
91	>	// set our sender
92	>	smtp.setSender(_cp.getProperty(_name, "Alerter.EMail.sender"));
93
94	<	// sort out the message body
95	<	String message = _message;
70	<	message = StringUtils.replaceText(message, "%level%", String.valueOf(alert.getLevel()));
71	<	message = StringUtils.replaceText(message, "%source%", alert.getSource());
72	<	message = StringUtils.replaceText(message, "%value%", alert.getValue());
73	<	message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue());
74	<	message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName());
94	>	// list of destination addresses
95	>	String destList = _cp.getProperty("Host."+alert.getSource(), "Alerter.EMail.destList");
96
97	<	try {
98	<	// create SMTP message
99	<	Smtp smtp = new Smtp(_smtpServer);
100	<	// set our sender
80	<	smtp.setSender(_sender);
81	<
82	<	// set the to list
83	<	StringTokenizer st = new StringTokenizer(_destList, ";");
84	<	while (st.hasMoreTokens()) {
85	<	smtp.setTo(st.nextToken());
86	<	}
87	<
88	<	// prepare to print the message
89	<	PrintWriter out = smtp.getOutputStream();
90	<	out.println("Subject: "+subject);
91	<	out.println();
92	<
93	<	// send the message
94	<	out.println(message);
95	<	smtp.sendMessage();
96	<	smtp.close();
97	<	_logger.write(toString(), Logger.DEBUG, "Sending IRC Alert at level"+String.valueOf(alert.getLevel()));
97	>	// set the to: list
98	>	StringTokenizer st = new StringTokenizer(destList, ";");
99	>	while (st.hasMoreTokens()) {
100	>	smtp.setTo(st.nextToken());
101		}
102	<	catch(IOException e) {
103	<	_logger.write(toString(), Logger.ERROR, "Error whilst sending message: "+e);
104	<	}
102	>
103	>	// prepare to print the message
104	>	PrintWriter out = smtp.getOutputStream();
105	>	out.println("Subject: "+subject+"\n");
106	>
107	>	// send the message
108	>	out.println(message);
109	>	smtp.sendMessage();
110	>	smtp.close();
111	>	_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ Alert.alertLevels[alert.getLevel()] + " level");
112		}
113	+	catch(IOException e) {
114	+	_logger.write(toString(), Logger.ERROR, "Error whilst sending message: "+e);
115	+	}
116	+	catch(PropertyNotFoundException e) {
117	+	_logger.write(toString(), Logger.ERROR, "Error obtaining essential configuration: "+e);
118	+	}
119		}
120
121		/**
122		* Overrides the {@link java.lang.Object#toString() Object.toString()}
123		* method to provide clean logging (every class should have this).
124		*
125	<	* This uses the uk.ac.ukc.iscream.util.NameFormat class
125	>	* This uses the uk.org.iscream.cms.server.util.NameFormat class
126		* to format the toString()
127		*
128		* @return the name of this class and its CVS revision
#	Line 119 | Line 135 | public class EMail__Alerter implements PluginAlerter {
135		}
136
137		/**
138	<	* return the String representation of what the filter does
138	>	* Return the String representation of what the alerter does
139	>	*
140	>	* @return the description
141		*/
142		public String getDescription(){
143		return DESC;
144		}
145
146		//---PRIVATE METHODS---
147	<
147	>
148		//---ACCESSOR/MUTATOR METHODS---
149	+
150	+	/**
151	+	* Returns the "friendly" name of this class. This
152	+	* is simply an accessor for _name, required due to
153	+	* inheritance issues with extending AlerterSkeleton.
154	+	*
155	+	* @return the friendly name
156	+	*/
157	+	protected String getFName() {
158	+	return _name;
159	+	}
160
161		//---ATTRIBUTES---
133	–
134	–	// an integer value
135	–	private int _level;
162
137	–	// a semi-colon seperated list of destination addresses
138	–	private String _destList;
139	–
140	–	// a single sender address
141	–	private String _sender;
142	–
143	–	// the fqdn of an smtp server
144	–	private String _smtpServer;
145	–
146	–	// a subject with the following: %level% and %message%
147	–	// eg, "i-scream e-mail alert: level %level%, %message%"
148	–	private String _subject;
149	–
150	–	// a message body with the following: %level% and %message%
151	–	private String _message;
152	–
163		/**
164		* This is the friendly identifier of the
165		* component this class is running in.
#	Line 159 | Line 169 | public class EMail__Alerter implements PluginAlerter {
169		* can be placed here.  This name could also
170		* be changed to null for utility classes.
171		*/
172	<	private String _name = ClientMain.NAME;
173	<
164	<	/**
165	<	* This holds a reference to the
166	<	* system logger that is being used.
167	<	*/
168	<	private Logger _logger = ReferenceManager.getInstance().getLogger();
169	<
172	>	protected String _name = "EMail";
173	>
174		//---STATIC ATTRIBUTES---
175
176		}

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines