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.14 by tdb, Mon Mar 5 23:13:22 2001 UTC vs.
Revision 1.23 by tdb, Sun May 13 01:47:44 2001 UTC

#	Line 1 | Line 1
1		//---PACKAGE DECLARATION---
2	<	package uk.ac.ukc.iscream.client.alerters;
2	>	package uk.org.iscream.client.alerters;
3
4		//---IMPORTS---
5	<	import uk.ac.ukc.iscream.client.*;
6	<	import uk.ac.ukc.iscream.core.*;
7	<	import uk.ac.ukc.iscream.util.*;
8	<	import uk.ac.ukc.iscream.componentmanager.*;
9	<
10	<	import java.util.*;
5	>	import uk.org.iscream.client.*;
6	>	import uk.org.iscream.core.*;
7	>	import uk.org.iscream.util.*;
8	>	import uk.org.iscream.componentmanager.*;
9		import java.io.*;
10	+	import java.util.StringTokenizer;
11
12	+
13		/**
14		* This alerter delivers alerts using e-mail.
15		*
16		* @author  $Author$
17		* @version $Id$
18		*/
19	<	public class EMail__Alerter implements PluginAlerter {
19	>	public class EMail__Alerter extends AlerterSkeleton {
20
21		//---FINAL ATTRIBUTES---
22
#	Line 25 | Line 25 | public class EMail__Alerter implements PluginAlerter {
25		*/
26		public final String REVISION = "$Revision$";
27
28	+	/**
29	+	* A description of this alerter
30	+	*/
31		public final String DESC = "Sends alerts over e-mail.";
32
30	–	public final String DEFAULT_LEVEL = Alert.alertLevels[0];
31	–
32	–	public final String NOT_CONFIGURED = "<NOT CONFIGURED>";
33	–
33		//---STATIC METHODS---
34
35		//---CONSTRUCTORS---
36
38	–	public EMail__Alerter() {
39	–	_logger.write(toString(), Logger.SYSINIT, "IRC Alerter started");
40	–	}
41	–
37		//---PUBLIC METHODS---
38
39	+	/**
40	+	* Implements the abstract method from the skeleton class.
41	+	* This method will attempt to send an alert
42	+	* message using the configured email configuration.
43	+	*
44	+	* @param alert the alert to send
45	+	*/
46		public void sendAlert(Alert alert) {
47	<	ConfigurationProxy cp = ConfigurationProxy.getInstance();
48	<	String levelName;
47	>	// get the subject and replace fields
48	>	String subject;
49		try {
50	<	levelName = cp.getProperty(_name, "Alerter.EMail.level");
50	>	subject = _cp.getProperty(_name, "Alerter.EMail.subject");
51		} catch (PropertyNotFoundException e) {
52	<	levelName = DEFAULT_LEVEL;
53	<	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.level value unavailable using default of " + levelName);
52	>	subject = NOT_CONFIGURED;
53	>	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.subject value unavailable using default of " + subject);
54		}
55	<	int level = StringUtils.getStringPos(levelName, Alert.alertLevels);
56	<	// only send if it's equal (or above) our level
57	<	if(((alert.getLevel() == 0) && (alert.getLastLevel() >= level)) || (alert.getLevel() >= level)) {
58	<	String alertType = Alert.alertLevels[alert.getLevel()];
59	<	String thresholdType = Alert.thresholdLevels[alert.getThreshold()];
60	<	// sort out the subject
61	<	String subject;
62	<	try {
63	<	subject = cp.getProperty(_name, "Alerter.EMail.subject");
64	<	} catch (PropertyNotFoundException e) {
65	<	subject = NOT_CONFIGURED;
66	<	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.subject value unavailable using default of " + subject);
55	>	subject = processAlertMessage(subject, alert);
56	>
57	>	// get the message body and replace fields
58	>	String message;
59	>	try {
60	>	message = _cp.getProperty(_name, "Alerter.EMail.message");
61	>	} catch (PropertyNotFoundException e) {
62	>	message = NOT_CONFIGURED;
63	>	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.message value unavailable using default of " + message);
64	>	}
65	>	message = processAlertMessage(message, alert);
66	>
67	>	// attempt to send the actual message
68	>	try {
69	>	// create SMTP message
70	>	Smtp smtp = new Smtp(_cp.getProperty(_name, "Alerter.EMail.smtpServer"));
71	>	// set our sender
72	>	smtp.setSender(_cp.getProperty(_name, "Alerter.EMail.sender"));
73	>
74	>	// list of destination addresses
75	>	String destList = _cp.getProperty("Host."+alert.getSource(), "Alerter.EMail.destList");
76	>
77	>	// set the to: list
78	>	StringTokenizer st = new StringTokenizer(destList, ";");
79	>	while (st.hasMoreTokens()) {
80	>	smtp.setTo(st.nextToken());
81		}
82	<	subject = StringUtils.replaceText(subject, "%level%", alertType);
83	<	subject = StringUtils.replaceText(subject, "%threshold%", thresholdType);
84	<	subject = StringUtils.replaceText(subject, "%source%", alert.getSource());
85	<	subject = StringUtils.replaceText(subject, "%value%", alert.getValue());
86	<	subject = StringUtils.replaceText(subject, "%thresholdValue%", alert.getThresholdValue());
87	<	subject = StringUtils.replaceText(subject, "%attributeName%", alert.getAttributeName());
88	<	subject = StringUtils.replaceText(subject, "%timeTillNextAlert%",  getTimeString(Long.parseLong(alert.getTimeTillNextAlert())));
89	<
90	<	// sort out the message body
91	<	String message;
76	<	try {
77	<	message = cp.getProperty(_name, "Alerter.EMail.message");
78	<	} catch (PropertyNotFoundException e) {
79	<	message = NOT_CONFIGURED;
80	<	_logger.write(toString(), Logger.WARNING, "Alerter.EMail.message value unavailable using default of " + message);
81	<	}
82	<	message = StringUtils.replaceText(message, "%level%", alertType);
83	<	message = StringUtils.replaceText(message, "%threshold%", thresholdType);
84	<	message = StringUtils.replaceText(message, "%source%", alert.getSource());
85	<	message = StringUtils.replaceText(message, "%value%", alert.getValue());
86	<	message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue());
87	<	message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName());
88	<	message = StringUtils.replaceText(message, "%timeTillNextAlert%",  getTimeString(Long.parseLong(alert.getTimeTillNextAlert())));
89	<
90	<	try {
91	<	// create SMTP message
92	<	Smtp smtp = new Smtp(cp.getProperty(_name, "Alerter.EMail.smtpServer"));
93	<	// set our sender
94	<	smtp.setSender(cp.getProperty(_name, "Alerter.EMail.sender"));
95	<
96	<	// get the default destination list
97	<	String destList = cp.getProperty(_name, "Alerter.EMail.defaultDestList");
98	<	// check if the source we're alerting about has a specific destination
99	<	String sourceDestList = cp.getProperty("Host."+alert.getSource(), "Alerter.EMail.destList");
100	<	if(sourceDestList != null) {
101	<	// if there is a source destination list, use it
102	<	destList = sourceDestList;
103	<	}
104	<
105	<	// set the to: list
106	<	StringTokenizer st = new StringTokenizer(destList, ";");
107	<	while (st.hasMoreTokens()) {
108	<	smtp.setTo(st.nextToken());
109	<	}
110	<
111	<	// prepare to print the message
112	<	PrintWriter out = smtp.getOutputStream();
113	<	out.println("Subject: "+subject);
114	<	out.println();
115	<
116	<	// send the message
117	<	out.println(message);
118	<	smtp.sendMessage();
119	<	smtp.close();
120	<	_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ alertType + " level");
121	<	}
122	<	catch(IOException e) {
123	<	_logger.write(toString(), Logger.ERROR, "Error whilst sending message: "+e);
124	<	}
125	<	catch(PropertyNotFoundException e) {
126	<	_logger.write(toString(), Logger.ERROR, "Error obtaining essential configuration: "+e);
127	<	}
82	>
83	>	// prepare to print the message
84	>	PrintWriter out = smtp.getOutputStream();
85	>	out.println("Subject: "+subject+"\n");
86	>
87	>	// send the message
88	>	out.println(message);
89	>	smtp.sendMessage();
90	>	smtp.close();
91	>	_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ Alert.alertLevels[alert.getLevel()] + " level");
92		}
93	+	catch(IOException e) {
94	+	_logger.write(toString(), Logger.ERROR, "Error whilst sending message: "+e);
95	+	}
96	+	catch(PropertyNotFoundException e) {
97	+	_logger.write(toString(), Logger.ERROR, "Error obtaining essential configuration: "+e);
98	+	}
99		}
100
101		/**
102		* Overrides the {@link java.lang.Object#toString() Object.toString()}
103		* method to provide clean logging (every class should have this).
104		*
105	<	* This uses the uk.ac.ukc.iscream.util.NameFormat class
105	>	* This uses the uk.org.iscream.util.NameFormat class
106		* to format the toString()
107		*
108		* @return the name of this class and its CVS revision
#	Line 145 | Line 115 | public class EMail__Alerter implements PluginAlerter {
115		}
116
117		/**
118	<	* return the String representation of what the filter does
118	>	* Return the String representation of what the alerter does
119	>	*
120	>	* @return the description
121		*/
122		public String getDescription(){
123		return DESC;
124		}
125
126		//---PRIVATE METHODS---
155	–
156	–	private String getTimeString(long time) {
157	–	String timeString = null;
158	–	if (time >= 60) {
159	–	timeString = (time / 60) + " minutes";
160	–	} else if (time >= 3600) {
161	–	timeString = ((time/60) / 60) + " hours";
162	–	} else {
163	–	timeString = time + " seconds";
164	–	}
165	–	return timeString;
166	–	}
127
128		//---ACCESSOR/MUTATOR METHODS---
129	+
130	+	/**
131	+	* Returns the "friendly" name of this class. This
132	+	* is simply an accessor for _name, required due to
133	+	* inheritance issues with extending AlerterSkeleton.
134	+	*
135	+	* @return the friendly name
136	+	*/
137	+	protected String getFName() {
138	+	return _name;
139	+	}
140
141		//---ATTRIBUTES---
142
#	Line 178 | Line 149 | public class EMail__Alerter implements PluginAlerter {
149		* can be placed here.  This name could also
150		* be changed to null for utility classes.
151		*/
152	<	private String _name = "EMail Alert";
153	<
183	<	/**
184	<	* This holds a reference to the
185	<	* system logger that is being used.
186	<	*/
187	<	private Logger _logger = ReferenceManager.getInstance().getLogger();
188	<
152	>	protected String _name = "EMail";
153	>
154		//---STATIC ATTRIBUTES---
155
156		}

Diff Legend

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