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 |
|
|
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 |
|
|
33 |
|
//---STATIC METHODS--- |
34 |
|
|
35 |
|
//---CONSTRUCTORS--- |
36 |
|
|
34 |
– |
public EMail__Alerter() { |
35 |
– |
_logger.write(toString(), Logger.SYSINIT, "IRC Alerter started"); |
36 |
– |
} |
37 |
– |
|
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 = cp.getProperty(_name, "Alerter.EMail.level"); |
49 |
< |
int level = StringUtils.getStringPos(levelName, Alert.alertLevels); |
50 |
< |
// only send if it's equal (or above) our level |
51 |
< |
if(alert.getLevel() >= level) { |
52 |
< |
String alertType = Alert.alertLevels[alert.getLevel()]; |
53 |
< |
String thresholdType = Alert.thresholdLevels[alert.getThreshold()]; |
54 |
< |
// sort out the subject |
55 |
< |
String subject = cp.getProperty(_name, "Alerter.EMail.subject"); |
56 |
< |
subject = StringUtils.replaceText(subject, "%level%", alertType); |
57 |
< |
subject = StringUtils.replaceText(subject, "%threshold%", thresholdType); |
58 |
< |
subject = StringUtils.replaceText(subject, "%source%", alert.getSource()); |
59 |
< |
subject = StringUtils.replaceText(subject, "%value%", alert.getValue()); |
60 |
< |
subject = StringUtils.replaceText(subject, "%thresholdValue%", alert.getThresholdValue()); |
61 |
< |
subject = StringUtils.replaceText(subject, "%attributeName%", alert.getAttributeName()); |
62 |
< |
subject = StringUtils.replaceText(subject, "%timeTillNextAlert%", getTimeString(Long.parseLong(alert.getTimeTillNextAlert()))); |
63 |
< |
|
64 |
< |
// sort out the message body |
65 |
< |
String message = cp.getProperty(_name, "Alerter.EMail.message"); |
66 |
< |
message = StringUtils.replaceText(message, "%level%", alertType); |
67 |
< |
message = StringUtils.replaceText(message, "%threshold%", thresholdType); |
68 |
< |
message = StringUtils.replaceText(message, "%source%", alert.getSource()); |
69 |
< |
message = StringUtils.replaceText(message, "%value%", alert.getValue()); |
70 |
< |
message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue()); |
71 |
< |
message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName()); |
72 |
< |
message = StringUtils.replaceText(message, "%timeTillNextAlert%", getTimeString(Long.parseLong(alert.getTimeTillNextAlert()))); |
73 |
< |
|
74 |
< |
try { |
75 |
< |
// create SMTP message |
76 |
< |
Smtp smtp = new Smtp(cp.getProperty(_name, "Alerter.EMail.smtpServer")); |
77 |
< |
// set our sender |
78 |
< |
smtp.setSender(cp.getProperty(_name, "Alerter.EMail.sender")); |
79 |
< |
|
80 |
< |
// set the to list |
75 |
< |
StringTokenizer st = new StringTokenizer(cp.getProperty(_name, "Alerter.EMail.destList"), ";"); |
76 |
< |
while (st.hasMoreTokens()) { |
77 |
< |
smtp.setTo(st.nextToken()); |
78 |
< |
} |
79 |
< |
|
80 |
< |
// prepare to print the message |
81 |
< |
PrintWriter out = smtp.getOutputStream(); |
82 |
< |
out.println("Subject: "+subject); |
83 |
< |
out.println(); |
84 |
< |
|
85 |
< |
// send the message |
86 |
< |
out.println(message); |
87 |
< |
smtp.sendMessage(); |
88 |
< |
smtp.close(); |
89 |
< |
_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ levelName + " level"); |
47 |
> |
// get the subject and replace fields |
48 |
> |
String subject; |
49 |
> |
try { |
50 |
> |
subject = _cp.getProperty(_name, "Alerter.EMail.subject"); |
51 |
> |
} catch (PropertyNotFoundException e) { |
52 |
> |
subject = NOT_CONFIGURED; |
53 |
> |
_logger.write(toString(), Logger.WARNING, "Alerter.EMail.subject value unavailable using default of " + subject); |
54 |
> |
} |
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 |
< |
catch(IOException e) { |
83 |
< |
_logger.write(toString(), Logger.ERROR, "Error whilst sending message: "+e); |
84 |
< |
} |
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 |
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--- |
121 |
– |
|
122 |
– |
private String getTimeString(long time) { |
123 |
– |
String timeString = null; |
124 |
– |
if (time >= 60) { |
125 |
– |
timeString = (time / 60) + " minutes"; |
126 |
– |
} else if (time >= 3600) { |
127 |
– |
timeString = ((time/60) / 60) + " hours"; |
128 |
– |
} else { |
129 |
– |
timeString = time + " seconds"; |
130 |
– |
} |
131 |
– |
return timeString; |
132 |
– |
} |
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 |
|
|
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 |
< |
|
149 |
< |
/** |
150 |
< |
* This holds a reference to the |
151 |
< |
* system logger that is being used. |
152 |
< |
*/ |
153 |
< |
private Logger _logger = ReferenceManager.getInstance().getLogger(); |
154 |
< |
|
152 |
> |
protected String _name = "EMail"; |
153 |
> |
|
154 |
|
//---STATIC ATTRIBUTES--- |
155 |
|
|
156 |
|
} |