EmailPublisher.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.cruisecontrol.publishers |
 |
 |
CruiseControl |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' |  |
| RETURNS | Number of return points from functions | |
| EXITS | Procedure exits | |
| SIZE | Size of the file in bytes | |
| FUNCTIONS | Number of function declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| CYCLOMATIC | Cyclomatic complexity | |
| UNIQUE_OPERANDS | Number of unique operands | |
| BLOCKS | Number of blocks | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOOPS | Number of loops | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| OPERATORS | Number of operators | |
| OPERANDS | Number of operands | |
| LINES | Number of lines in the source file | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| COMPARISONS | Number of comparison operators | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| PARAMS | Number of formal parameter declarations | |
| COMMENTS | Comment lines | |
| WHITESPACE | Number of whitespace lines | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0137 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0118 | JAVA0118 Missing javadoc: type 'type' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0062 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/********************************************************************************
* CruiseControl, a Continuous Integration Toolkit
* Copyright (c) 2001-2003, ThoughtWorks, Inc.
* 200 E. Randolph, 25th Floor
* Chicago, IL 60601 USA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* + Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* + Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/
package net.sourceforge.cruisecontrol.publishers;
import java.io.File;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.SendFailedException;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.AddressException;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import net.sourceforge.cruisecontrol.CruiseControlException;
import net.sourceforge.cruisecontrol.Modification;
import net.sourceforge.cruisecontrol.Publisher;
import net.sourceforge.cruisecontrol.publishers.email.EmailMapper;
import net.sourceforge.cruisecontrol.publishers.email.EmailMapperHelper;
import net.sourceforge.cruisecontrol.publishers.email.EmailMapping;
import net.sourceforge.cruisecontrol.util.ValidationHelper;
import net.sourceforge.cruisecontrol.util.XMLLogHelper;
import org.apache.log4j.Logger;
import org.apache.oro.io.GlobFilenameFilter;
import org.apache.oro.text.MalformedCachePatternException;
import org.apache.commons.validator.EmailValidator;
import org.jdom.Element;
/**
* Abstract implementation of the <code>Publisher</code> interface, specifically tailored for sending email. The only
* abstract method is createMessage, which allows different implementations to send different messages as the body of
* the email. As it currently stands, there is one concrete implementation-- <code>LinkEmailPublisher</code>, but the
* ability to create <code>EmailPublisher</code>s that handle sending a text summary or an html summary is there.
*
* @author alden almagro, ThoughtWorks, Inc. 2002
*/
public abstract class EmailPublisher implements Publisher {
private static final Logger LOG = Logger.getLogger(EmailPublisher.class);
private String mailHost;
private String userName;
private String password;
private String mailPort;
private boolean useSSL;
private String buildResultsURL;
private Always[] alwaysAddresses = new Always[0];
private Failure[] failureAddresses = new Failure[0];
private Success[] successAddresses = new Success[0];
private Alert[] alertAddresses = new Alert[0];
private Ignore[] ignoreUsers = new Ignore[0];
private EmailMapper[] emailMapper = new EmailMapper[0];
private EmailMapperHelper mapperHelper = new EmailMapperHelper();
private String returnAddress;
private String returnName;
private String defaultSuffix = "";
private String reportSuccess = "always";
private boolean spamWhileBroken = true;
private boolean skipUsers = false;
private String subjectPrefix;
private boolean failAsImportant = true;
/**
* Implementations of this method will create the email message body.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @return <code>String</code> containing the message
*/
protected abstract String createMessage(XMLLogHelper logHelper);
/*
* Called after the configuration is read to make sure that all the mandatory parameters were specified.. @throws
* CruiseControlException if there was a configuration error.
*/
public void validate() throws CruiseControlException {
ValidationHelper.assertIsSet(getMailHost(), "mailhost", this.getClass());
ValidationHelper.assertIsSet(getReturnAddress(), "returnaddress", this.getClass());
ValidationHelper.assertFalse(getUsername() != null && getPassword() == null,
"'password' is required if 'username' is set for email.");
ValidationHelper.assertFalse(getPassword() != null && getUsername() == null,
"'username' is required if 'password' is set for email.");
validateAddresses(alwaysAddresses);
validateAddresses(alertAddresses);
validateAddresses(failureAddresses);
validateAddresses(successAddresses);
for (int i = 0; i < ignoreUsers.length; i++) {
ignoreUsers[i].validate();
}
}
private void validateAddresses(Address[] addresses) throws CruiseControlException {
for (int i = 0; i < addresses.length; i++) {
addresses[i].validate();
}
}
/**
* Creates the subject line for the email message.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @return <code>String</code> containing the subject line.
*/
protected String createSubject(XMLLogHelper logHelper) throws CruiseControlException {
StringBuffer subjectLine = new StringBuffer();
if (subjectPrefix != null) {
subjectLine.append(subjectPrefix).append(" ");
}
subjectLine.append(logHelper.getProjectName());
if (logHelper.isBuildSuccessful()) {
String label = logHelper.getLabel();
if (label.trim().length() > 0) {
subjectLine.append(" ").append(logHelper.getLabel());
}
// Anytime the build is "fixed" the subjest line
// should read "fixed". It might confuse recipients...but
// it shouldn't
if (logHelper.isBuildFix()) {
subjectLine.append(" Build Fixed");
} else {
subjectLine.append(" Build Successful");
}
} else {
subjectLine.append(" Build Failed");
}
return subjectLine.toString();
}
/**
* Determines if the conditions are right for the email to be sent.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @return whether or not the mail message should be sent.
*/
protected boolean shouldSend(XMLLogHelper logHelper) throws CruiseControlException {
if (logHelper.isBuildSuccessful()) {
if (reportSuccess.equalsIgnoreCase("always")) {
return true;
}
if (reportSuccess.equalsIgnoreCase("fixes")) {
if (logHelper.wasPreviousBuildSuccessful()) {
LOG.debug("reportSuccess is set to 'fixes', not sending emails for repeated successful builds.");
return false;
} else {
return true;
}
}
if (reportSuccess.equalsIgnoreCase("never")) {
LOG.debug("reportSuccess is set to 'never', not sending emails for successful builds.");
return false;
}
} else { // build wasn't successful
if (!logHelper.wasPreviousBuildSuccessful() && logHelper.isBuildNecessary() && !spamWhileBroken) {
LOG.debug("spamWhileBroken is set to false, not sending email");
return false;
}
}
return true;
}
/**
* Creates the list of email addresses to receive the email message. Uses configured emailmappers to map user names
* to email addresses. After all mappings are done, mapped users are checked for existence of the domain part
* (i.e @mydomain.com) in the mapped email address. If it doesn't exist, default (if configured) is appended Any
* addresses set in the <code>addAlwaysAddress</code> method will always receive the email if it is sent. Any
* address set in the <code>addFailureAddress</code> method will receive the message if the build has failed.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @return comma delimited <code>String</code> of email addresses to receive the email message.
*/
protected String createUserList(XMLLogHelper logHelper) throws CruiseControlException {
Set emails = createUserSet(logHelper);
return createEmailString(emails);
}
/**
* Creates the <code>Set</code> of email addresses to receive the email message.
* <p>
* Uses configured emailmappers to map user names to email addresses. After all mappings are done, mapped users are
* checked for existence of the domain part (i.e @mydomain.com) in the mapped email address. If it doesn't exist,
* default (if configured) is appended Any addresses set in the <code>addAlwaysAddress</code> method will always
* receive the email if it is sent. Any address set in the <code>addFailureAddress</code> method will receive the
* message if the build has failed.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @return A <code>Set</code> of email addresses to receive the email message.
*/
protected Set createUserSet(XMLLogHelper logHelper) throws CruiseControlException {
Set users = skipUsers ? new HashSet() : logHelper.getBuildParticipants();
// remove users we want to exclude from the mail spam
for (int i = 0; i < ignoreUsers.length; i++) {
users.remove(ignoreUsers[i].getUser());
}
// add always addresses
for (int i = 0; i < alwaysAddresses.length; i++) {
users.add(alwaysAddresses[i].getAddress());
}
// if build failed, add failure addresses
if (!logHelper.isBuildSuccessful()) {
for (int i = 0; i < failureAddresses.length; i++) {
users.add(failureAddresses[i].getAddress());
}
}
// If build fixed, add failure addresses that want to know about the fix
if (logHelper.isBuildFix()) {
for (int i = 0; i < failureAddresses.length; i++) {
if (failureAddresses[i].shouldReportWhenFixed()) {
users.add(failureAddresses[i].getAddress());
}
}
}
// if build succeeded, add success addresses
if (logHelper.isBuildSuccessful()) {
for (int i = 0; i < successAddresses.length; i++) {
users.add(successAddresses[i].getAddress());
}
}
Set emails = new TreeSet();
mapperHelper.mapUsers(this, users, emails);
for (Iterator iterator = emails.iterator(); iterator.hasNext();) {
String email = (String) iterator.next();
if (!isValid(email)) {
LOG.warn("Invalid email: " + email);
}
}
return emails;
}
boolean isValid(String address) {
return EmailValidator.getInstance().isValid(address);
}
/**
* Implementing the <code>Publisher</code> interface. Sends modification alert and regular build emails. If a user
* is supposed to receive a modification alert and a regular build email, they will only receive the modification
* alert. This prevents duplicate emails (currently only the subject is different).
*/
public void publish(Element cruisecontrolLog) throws CruiseControlException {
XMLLogHelper helper = new XMLLogHelper(cruisecontrolLog);
boolean important = failAsImportant && !helper.isBuildSuccessful();
Set userSet = new HashSet();
Set alertSet = createAlertUserSet(helper);
String subject = createSubject(helper);
if (!alertSet.isEmpty()) {
String alertSubject = "[MOD ALERT] " + subject;
sendMail(createEmailString(alertSet), alertSubject, createMessage(helper), important);
}
if (shouldSend(helper)) {
userSet.addAll(createUserSet(helper));
// Do not send duplicates to users who received an alert email
userSet.removeAll(alertSet);
if (!userSet.isEmpty()) {
sendMail(createEmailString(userSet), subject, createMessage(helper), important);
} else {
if (alertSet.isEmpty()) {
LOG.info("No recipients, so not sending email");
}
}
}
}
/**
* builds the properties object for the mail session
*
* @return a properties object containing configured properties.
*/
protected Properties getMailProperties() {
Properties props = System.getProperties();
props.put("mail.smtp.host", mailHost);
props.put("mail.smtp.sendpartial", "true");
if (mailPort != null) {
props.put("mail.smtp.port", mailPort);
}
LOG.debug("mailHost is " + mailHost + ", mailPort is " + mailPort == null ? "default" : mailPort);
if (userName != null && password != null) {
props.put("mail.smtp.auth", "true");
if (useSSL) {
if (mailPort != null) {
props.put("mail.smtp.socketFactory.port", mailPort);
}
props.put("mail.smtp.socketFactory.class", "javax.net.ssl.SSLSocketFactory");
props.put("mail.smtp.socketFactory.fallback", "false");
}
}
return props;
}
/**
* Sends an email message.
*
* @param toList
* comma delimited <code>String</code> of email addresses
* @param subject
* subject line for the message
* @param message
* body of the message
* @return Boolean value indicating if an email was sent.
*/
protected boolean sendMail(String toList, String subject, String message, boolean important)
throws CruiseControlException {
boolean emailSent = false;
if (toList != null && toList.trim().length() != 0) {
LOG.debug("Sending email to: " + toList);
Session session = Session.getDefaultInstance(getMailProperties(), null);
session.setDebug(LOG.isDebugEnabled());
try {
Message msg = new MimeMessage(session);
msg.setFrom(getFromAddress());
msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toList, false));
msg.setSubject(subject);
msg.setSentDate(new Date());
String importance = (important) ? "High" : "Normal";
msg.addHeader("Importance", importance);
addContentToMessage(message, msg);
if (userName != null && password != null) {
msg.saveChanges(); // implicit with send()
Transport transport = session.getTransport("smtp");
transport.connect(mailHost, userName, password);
transport.sendMessage(msg, msg.getAllRecipients());
transport.close();
} else {
Transport.send(msg);
}
emailSent = true;
} catch (SendFailedException e) {
LOG.warn(e.getMessage(), e);
} catch (MessagingException e) {
throw new CruiseControlException(e.getClass().getName() + ": " + e.getMessage(), e);
}
}
return emailSent;
}
/**
* Subclasses can override this method to control how the content is added to the Message.
*
* @param content
* content returned by createMessage
* @param msg
* mail Message with headers and addresses added elsewhere
* @throws MessagingException
*/
protected void addContentToMessage(String content, Message msg) throws MessagingException {
msg.setText(content);
}
protected InternetAddress getFromAddress() throws AddressException {
InternetAddress fromAddress = new InternetAddress(returnAddress);
if (returnName != null) {
try {
fromAddress = new InternetAddress(returnAddress, returnName);
} catch (UnsupportedEncodingException e) {
LOG.error("error setting returnName [" + returnName + "]: " + e.getMessage());
}
}
return fromAddress;
}
public void setMailHost(String hostname) {
mailHost = hostname;
}
public String getMailHost() {
return mailHost;
}
public void setUsername(String name) {
userName = name;
}
public String getUsername() {
return userName;
}
public void setPassword(String passwd) {
password = passwd;
}
public String getPassword() {
return password;
}
public void setMailPort(String port) {
mailPort = port;
}
public String getMailPort() {
return mailPort;
}
public void setUseSSL(boolean useSSL) {
this.useSSL = useSSL;
}
public void setSubjectPrefix(String prefix) {
subjectPrefix = prefix;
}
public String getSubjectPrefix() {
return subjectPrefix;
}
public String getBuildResultsURL() {
return buildResultsURL;
}
public void setBuildResultsURL(String url) {
buildResultsURL = url;
}
public EmailMapper[] getEmailMapper() {
return emailMapper;
}
public String getReturnAddress() {
return returnAddress;
}
public void setReturnAddress(String emailAddress) {
returnAddress = emailAddress;
}
public String getReturnName() {
return returnName;
}
public void setReturnName(String emailReturnName) {
returnName = emailReturnName;
}
public String getDefaultSuffix() {
return defaultSuffix;
}
public void setDefaultSuffix(String defaultEmailSuffix) {
defaultSuffix = defaultEmailSuffix;
}
public void setReportSuccess(String report) {
reportSuccess = report;
}
public void setSkipUsers(boolean skip) {
skipUsers = skip;
}
public void setSpamWhileBroken(boolean spam) {
spamWhileBroken = spam;
}
public void setFailAsImportant(boolean important) {
failAsImportant = important;
}
public Ignore createIgnore() {
List ignoreList = new ArrayList();
ignoreList.addAll(Arrays.asList(ignoreUsers));
Ignore ignore = new Ignore();
ignoreList.add(ignore);
ignoreUsers = (Ignore[]) ignoreList.toArray(new Ignore[0]);
return ignore;
}
public Always createAlways() {
List alwaysList = new ArrayList();
alwaysList.addAll(Arrays.asList(alwaysAddresses));
Always always = new Always();
alwaysList.add(always);
alwaysAddresses = (Always[]) alwaysList.toArray(new Always[0]);
return always;
}
public Failure createFailure() {
List failureList = new ArrayList();
failureList.addAll(Arrays.asList(failureAddresses));
Failure failure = new Failure();
failureList.add(failure);
failureAddresses = (Failure[]) failureList.toArray(new Failure[0]);
return failure;
}
public Success createSuccess() {
List successList = new ArrayList();
successList.addAll(Arrays.asList(successAddresses));
Success success = new Success();
successList.add(success);
successAddresses = (Success[]) successList.toArray(new Success[0]);
return success;
}
public Alert createAlert() {
List alertsList = new ArrayList();
alertsList.addAll(Arrays.asList(alertAddresses));
Alert alert = new Alert();
alertsList.add(alert);
alertAddresses = (Alert[]) alertsList.toArray(new Alert[0]);
return alert;
}
/*
* for the <map ... /> entries, just stuff them into the cache in EmailMapperHelper
*/
public void add(EmailMapping mapping) {
EmailMapperHelper.addCacheEntry(this, mapping.getAlias(), mapping.getAddress());
}
public void add(EmailMapper mapper) {
List mapperList = new ArrayList();
mapperList.addAll(Arrays.asList(emailMapper));
mapper.setPublisher(this);
mapperList.add(mapper);
emailMapper = (EmailMapper[]) mapperList.toArray(new EmailMapper[0]);
}
public static class Ignore implements Serializable {
private static final long serialVersionUID = 4763763343885476189L;
private String user;
public String getUser() {
return user;
}
public void validate() throws CruiseControlException {
ValidationHelper.assertIsSet(user, "user", getClass());
}
public void setUser(String theUser) {
user = theUser;
}
}
public static class Address implements Serializable {
private static final long serialVersionUID = -7143350548506511400L;
private String address;
public String getAddress() {
return address;
}
public void setAddress(String theAddress) {
address = theAddress;
}
public void validate() throws CruiseControlException {
ValidationHelper.assertIsSet(address, "address", getClass());
ValidationHelper.assertFalse(address.equals(""), "empty string is not a valid value of address for "
+ getClass().getName());
}
}
public static class Always extends Address {
private static final long serialVersionUID = -4906620821397147420L;
}
public static class Failure extends Address {
private static final long serialVersionUID = -6027290532428946586L;
/**
* Set to true to send an email to this "address" when the build gets fixed.
*/
private boolean reportWhenFixed = false;
public boolean shouldReportWhenFixed() {
return reportWhenFixed;
}
public void setReportWhenFixed(boolean reportWhenFixed) {
this.reportWhenFixed = reportWhenFixed;
}
}
public static class Success extends Address {
private static final long serialVersionUID = 8001068483405344504L;
}
public static class Alert extends Address {
private static final long serialVersionUID = 3644326033589789766L;
public void validate() throws CruiseControlException {
super.validate();
ValidationHelper.assertIsSet(fileRegExpr, "fileregexpr", getClass());
try {
fileFilter = new GlobFilenameFilter(fileRegExpr);
} catch (MalformedCachePatternException mcpe) {
ValidationHelper.fail("invalid regexp '" + fileRegExpr + "'", mcpe);
}
}
/**
* A regExpr for the file you are interested in watching
*/
private String fileRegExpr = null;
/**
* The compiled regExp, set on validation of the Publisher
*/
private GlobFilenameFilter fileFilter = null;
/**
* A <code>String</code> representing the regexp to match against modified files
*
* @param f
* A <code>String</code> representing the file that was modified
*/
public void setFileRegExpr(String f) {
this.fileRegExpr = f;
}
}
/**
* Creates the list of email addresses to receive an alert email message.
* <p>
* The full path of each modified file is compared against the regular expressions specified in the configuration.
* If a modified file's path matches a regular expression, the user's email address is included in the returned
* <code>String</code>.
* <p>
* Uses configured emailmappers to map user names to email addresses. After all mappings are done, mapped users are
* checked for existence of the domain part (i.e @mydomain.com) in the mapped email address. If it doesn't exist,
* default (if configured) is appended.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @return comma delimited <code>String</code> of email addresses to receive the email message.
*/
protected String createAlertUserList(XMLLogHelper logHelper) throws CruiseControlException {
return createEmailString(createAlertUserSet(logHelper));
}
/**
* Creates a <code>Set</code> of email addresses to receive an alert email message based on the logHelper.
*
* @param logHelper
* <code>XMLLogHelper</code> wrapper for the build log.
* @throws CruiseControlException
* @return A <code>Set</code> of email addresses to receive the email message.
*/
protected Set createAlertUserSet(XMLLogHelper logHelper) throws CruiseControlException {
if (alertAddresses.length == 0) {
return Collections.EMPTY_SET;
}
Set users = new HashSet();
Set modificationSet = logHelper.getModifications();
for (Iterator modificationIter = modificationSet.iterator(); modificationIter.hasNext();) {
Modification mod = (Modification) modificationIter.next();
String modifiedFile = mod.getFullPath();
LOG.debug("Modified file: " + modifiedFile);
// Compare the modified file to the regExpr's
for (int i = 0; i < alertAddresses.length; i++) {
String emailAddress = alertAddresses[i].getAddress();
if (emailAddress != null && !"".equals(emailAddress.trim()) && !users.contains(emailAddress)
&& matchRegExpr(modifiedFile, alertAddresses[i].fileFilter)) {
// We have a new match, send an alert email
users.add(emailAddress);
LOG.info("Alert '" + emailAddress + "' because their fileRegExpr '"
+ alertAddresses[i].fileRegExpr + "' matched " + modifiedFile);
}
}
}
Set emails = new TreeSet();
mapperHelper.mapUsers(this, users, emails);
return emails;
}
/**
* Creates a comma delimited <code>String</code> from a <code>Set</code> of <code>String</code>s.
*
* @param emails
* A <code>Set</code> containing <code>String</code>s of emails addresses
* @return A comma delimited <code>String</code> of email addresses
*/
protected String createEmailString(Set emails) {
StringBuffer commaDelimitedString = new StringBuffer();
Iterator emailIterator = appendDefaultSuffix(emails).iterator();
while (emailIterator.hasNext()) {
String mappedUser = (String) emailIterator.next();
commaDelimitedString.append(mappedUser);
if (emailIterator.hasNext()) {
commaDelimitedString.append(",");
}
}
LOG.debug("List of emails: " + commaDelimitedString);
return commaDelimitedString.toString();
}
private Set appendDefaultSuffix(Set emails) {
Set result = new TreeSet();
Iterator emailIterator = emails.iterator();
while (emailIterator.hasNext()) {
String mappedUser = (String) emailIterator.next();
// append default suffix if need to
if (mappedUser.indexOf("@") < 0) {
mappedUser += defaultSuffix;
}
result.add(mappedUser);
}
return result;
}
/**
* Compare the input <code>String</code> against a regular expression pattern.
*
* @param input
* A <code>String</code> to compare against the regExpr pattern
* @param pattern
* A <code>GlobFilenameFilter</code> pattern
* @return True if the file matches the regular expression pattern. Otherwise false.
*/
protected boolean matchRegExpr(String input, GlobFilenameFilter pattern) {
File file = new File(input);
String path = file.toString();
// On systems with a '\' as pathseparator convert it to a forward slash '/'
// That makes patterns platform independent
if (File.separatorChar == '\\') {
path = path.replace('\\', '/');
}
return pattern.accept(file, path);
}
}
The table below shows all metrics for EmailPublisher.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 114.00 | Number of blocks | |
| BLOCK_COMMENT | 7.00 | Number of block comment lines | |
| COMMENTS | 194.00 | Comment lines | |
| COMMENT_DENSITY | 0.50 | Comment density | |
| COMPARISONS | 60.00 | Number of comparison operators | |
| CYCLOMATIC | 118.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 21.00 | Comments in declarations | |
| DOC_COMMENT | 173.00 | Number of javadoc comment lines | |
| ELOC | 390.00 | Effective lines of code | |
| EXEC_COMMENTS | 11.00 | Comments in executable code | |
| EXITS | 106.00 | Procedure exits | |
| FUNCTIONS | 59.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 76.73 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 136.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 2.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 7.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 40.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 6.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 2.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 2.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 1.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 3.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 1.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 8.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 835.00 | Number of lines in the source file | |
| LINE_COMMENT | 14.00 | Number of line comments | |
| LOC | 501.00 | Lines of code | |
| LOGICAL_LINES | 283.00 | Number of statements | |
| LOOPS | 12.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1204.00 | Number of operands | |
| OPERATORS | 2230.00 | Number of operators | |
| PARAMS | 40.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3434.00 | Halstead program length | |
| PROGRAM_VOCAB | 460.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 96.00 | Number of return points from functions | |
| SIZE | 30238.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 408.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 52.00 | Number of unique operators | |
| WHITESPACE | 140.00 | Number of whitespace lines | |