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.*; |
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 |
|
|
10 |
|
import java.util.*; |
11 |
|
import java.io.*; |
12 |
+ |
import java.text.*; |
13 |
|
|
14 |
|
/** |
15 |
< |
* This Alert sends by e-mail. |
15 |
> |
* This alerter delivers alerts using e-mail. |
16 |
|
* |
17 |
|
* @author $Author$ |
18 |
|
* @version $Id$ |
26 |
|
*/ |
27 |
|
public final String REVISION = "$Revision$"; |
28 |
|
|
29 |
< |
public final String DESC = "Sends alerts by e-mail"; |
29 |
> |
public final String DESC = "Sends alerts over e-mail."; |
30 |
|
|
31 |
+ |
public final String DEFAULT_LEVEL = Alert.alertLevels[0]; |
32 |
+ |
|
33 |
+ |
public final String NOT_CONFIGURED = "<NOT CONFIGURED>"; |
34 |
+ |
|
35 |
|
//---STATIC METHODS--- |
36 |
|
|
37 |
|
//---CONSTRUCTORS--- |
38 |
|
|
39 |
< |
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 |
< |
|
39 |
> |
public EMail__Alerter() { |
40 |
|
_logger.write(toString(), Logger.SYSINIT, "IRC Alerter started"); |
41 |
|
} |
42 |
|
|
43 |
|
//---PUBLIC METHODS--- |
44 |
|
|
45 |
|
public void sendAlert(Alert alert) { |
46 |
+ |
ConfigurationProxy cp = ConfigurationProxy.getInstance(); |
47 |
+ |
String levelName; |
48 |
+ |
try { |
49 |
+ |
levelName = cp.getProperty(_name, "Alerter.EMail.level"); |
50 |
+ |
} catch (PropertyNotFoundException e) { |
51 |
+ |
levelName = DEFAULT_LEVEL; |
52 |
+ |
_logger.write(toString(), Logger.WARNING, "Alerter.EMail.level value unavailable using default of " + levelName); |
53 |
+ |
} |
54 |
+ |
int level = StringUtils.getStringPos(levelName, Alert.alertLevels); |
55 |
|
// only send if it's equal (or above) our level |
56 |
< |
if(alert.getLevel() >= _level) { |
56 |
> |
if(((alert.getLevel() == 0) && (alert.getLastLevel() >= level)) || (alert.getLevel() >= level)) { |
57 |
> |
String alertType = Alert.alertLevels[alert.getLevel()]; |
58 |
> |
String thresholdType = Alert.thresholdLevels[alert.getThreshold()]; |
59 |
> |
String timeFirstSince = DateUtils.formatTime((System.currentTimeMillis() - alert.getInitialAlertTime())/1000, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs"); |
60 |
> |
String timeFirstOccured = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(alert.getInitialAlertTime())); |
61 |
> |
|
62 |
|
// sort out the subject |
63 |
< |
String subject = _subject; |
64 |
< |
subject = StringUtils.replaceText(subject, "%level%", String.valueOf(alert.getLevel())); |
63 |
> |
String subject; |
64 |
> |
try { |
65 |
> |
subject = cp.getProperty(_name, "Alerter.EMail.subject"); |
66 |
> |
} catch (PropertyNotFoundException e) { |
67 |
> |
subject = NOT_CONFIGURED; |
68 |
> |
_logger.write(toString(), Logger.WARNING, "Alerter.EMail.subject value unavailable using default of " + subject); |
69 |
> |
} |
70 |
> |
subject = StringUtils.replaceText(subject, "%level%", alertType); |
71 |
> |
subject = StringUtils.replaceText(subject, "%threshold%", thresholdType); |
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()); |
76 |
< |
|
76 |
> |
subject = StringUtils.replaceText(subject, "%timeTillNextAlert%", DateUtils.getTimeString(Long.parseLong(alert.getTimeTillNextAlert()))); |
77 |
> |
subject = StringUtils.replaceText(subject, "%timeSinceFirstAlert%", timeFirstSince); |
78 |
> |
subject = StringUtils.replaceText(subject, "%timeOfFirstAlert%", timeFirstOccured); |
79 |
> |
|
80 |
|
// sort out the message body |
81 |
< |
String message = _message; |
82 |
< |
message = StringUtils.replaceText(message, "%level%", String.valueOf(alert.getLevel())); |
81 |
> |
String message; |
82 |
> |
try { |
83 |
> |
message = cp.getProperty(_name, "Alerter.EMail.message"); |
84 |
> |
} catch (PropertyNotFoundException e) { |
85 |
> |
message = NOT_CONFIGURED; |
86 |
> |
_logger.write(toString(), Logger.WARNING, "Alerter.EMail.message value unavailable using default of " + message); |
87 |
> |
} |
88 |
> |
message = StringUtils.replaceText(message, "%level%", alertType); |
89 |
> |
message = StringUtils.replaceText(message, "%threshold%", thresholdType); |
90 |
|
message = StringUtils.replaceText(message, "%source%", alert.getSource()); |
91 |
|
message = StringUtils.replaceText(message, "%value%", alert.getValue()); |
92 |
|
message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue()); |
93 |
|
message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName()); |
94 |
< |
|
94 |
> |
message = StringUtils.replaceText(message, "%timeTillNextAlert%", DateUtils.getTimeString(Long.parseLong(alert.getTimeTillNextAlert()))); |
95 |
> |
message = StringUtils.replaceText(message, "%timeSinceFirstAlert%", timeFirstSince); |
96 |
> |
message = StringUtils.replaceText(message, "%timeOfFirstAlert%", timeFirstOccured); |
97 |
> |
|
98 |
|
try { |
99 |
|
// create SMTP message |
100 |
< |
Smtp smtp = new Smtp(_smtpServer); |
100 |
> |
Smtp smtp = new Smtp(cp.getProperty(_name, "Alerter.EMail.smtpServer")); |
101 |
|
// set our sender |
102 |
< |
smtp.setSender(_sender); |
102 |
> |
smtp.setSender(cp.getProperty(_name, "Alerter.EMail.sender")); |
103 |
|
|
104 |
< |
// set the to list |
105 |
< |
StringTokenizer st = new StringTokenizer(_destList, ";"); |
104 |
> |
String destList = cp.getProperty("Host."+alert.getSource(), "Alerter.EMail.destList"); |
105 |
> |
|
106 |
> |
// set the to: list |
107 |
> |
StringTokenizer st = new StringTokenizer(destList, ";"); |
108 |
|
while (st.hasMoreTokens()) { |
109 |
|
smtp.setTo(st.nextToken()); |
110 |
|
} |
118 |
|
out.println(message); |
119 |
|
smtp.sendMessage(); |
120 |
|
smtp.close(); |
121 |
< |
_logger.write(toString(), Logger.DEBUG, "Sending IRC Alert at level"+String.valueOf(alert.getLevel())); |
121 |
> |
_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ alertType + " level"); |
122 |
|
} |
123 |
|
catch(IOException e) { |
124 |
|
_logger.write(toString(), Logger.ERROR, "Error whilst sending message: "+e); |
125 |
|
} |
126 |
+ |
catch(PropertyNotFoundException e) { |
127 |
+ |
_logger.write(toString(), Logger.ERROR, "Error obtaining essential configuration: "+e); |
128 |
+ |
} |
129 |
|
} |
130 |
|
} |
131 |
|
|
133 |
|
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
134 |
|
* method to provide clean logging (every class should have this). |
135 |
|
* |
136 |
< |
* This uses the uk.ac.ukc.iscream.util.NameFormat class |
136 |
> |
* This uses the uk.org.iscream.util.NameFormat class |
137 |
|
* to format the toString() |
138 |
|
* |
139 |
|
* @return the name of this class and its CVS revision |
153 |
|
} |
154 |
|
|
155 |
|
//---PRIVATE METHODS--- |
156 |
< |
|
156 |
> |
|
157 |
|
//---ACCESSOR/MUTATOR METHODS--- |
158 |
|
|
159 |
|
//---ATTRIBUTES--- |
133 |
– |
|
134 |
– |
// an integer value |
135 |
– |
private int _level; |
160 |
|
|
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 |
– |
|
161 |
|
/** |
162 |
|
* This is the friendly identifier of the |
163 |
|
* component this class is running in. |
167 |
|
* can be placed here. This name could also |
168 |
|
* be changed to null for utility classes. |
169 |
|
*/ |
170 |
< |
private String _name = ClientMain.NAME; |
170 |
> |
private String _name = "EMail Alert"; |
171 |
|
|
172 |
|
/** |
173 |
|
* This holds a reference to the |