FCL/sftools/dev/build: comparison buildframework/helium/sf/java/core/src/com/nokia/helium/core/EmailDataSender.java

equal deleted inserted replaced

-:c7c26511138f
+:7c4a911dc066
 package com.nokia.helium.core;
 import java.util.Arrays;
 import java.util.Properties;
-import java.util.Hashtable;
 import java.util.zip.GZIPOutputStream;
 import java.io.BufferedInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
-import javax.mail.*;
-import javax.mail.internet.*;
+import javax.mail.BodyPart;
-import javax.naming.*;
+import javax.mail.Message;
-import javax.naming.directory.*;
+import javax.mail.MessagingException;
+import javax.mail.Session;
+import javax.mail.Transport;
+import javax.mail.internet.InternetAddress;
+import javax.mail.internet.MimeBodyPart;
+import javax.mail.internet.MimeMessage;
+import javax.mail.internet.MimeMultipart;
 import javax.activation.DataHandler;
 import javax.mail.util.ByteArrayDataSource;
+import javax.mail.internet.AddressException;
 import org.apache.log4j.Logger;
 import org.apache.commons.io.FileUtils;
 /**
 * Send compressed or uncompressed xml data with email.
 // Logger
 private static Logger log = Logger.getLogger(EmailDataSender.class);
 // Address email is sent from
 private String from;
 // The target address
 private String[] toAddressList;
 // LDAP config
 private String ldapURL;
 // TODO all reference to nokia internals MUST be removed.
 private String rootdn = "o=Nokia";
 // Configured smtp server address
 private String smtpServerAddress;
-/**
-* Constructor
+/**
-*
+* Constructor
-* @param String
+*
-*            comma separeted email recepients list
+* @param String comma separeted email recepients list
-* @param String
+* @param String smtp server
-*            smtp server
+* @param String ldap server
-* @param String
+*/
-*            ldap server
+public EmailDataSender(String toStrings, String smtpServer, String ldapAddress) {
-*/
-public EmailDataSender(String toStrings, String smtpServer,
-String ldapAddress) {
 if (toStrings != null) {
 String[] splitList = toStrings.split(",");
 toAddressList = splitList;
 }
 smtpServerAddress = smtpServer;
 ldapURL = ldapAddress;
 }
-/**
-* Constructor
+/**
-*
+* Constructor
-* @param String
+*
-*            email recepient list in array
+* @param String email recepient list in array
-* @param String
+* @param String smtp server
-*            smtp server
+* @param String ldap server
-* @param String
+*/
-*            ldap server
+public EmailDataSender(String[] toList, String smtpServer, String ldapAddress) {
-*/
-public EmailDataSender(String[] toList, String smtpServer,
-String ldapAddress) {
 toAddressList = toList;
 smtpServerAddress = smtpServer;
 ldapURL = ldapAddress;
 }
-/**
-* Constructor
+/**
-*
+* Constructor
-* @param String
+*
-*            email recepients list in array
+* @param String email recepients list in array
-* @param String
+* @param String smtp server
-*            smtp server
+* @param String ldap server
-* @param String
+* @param String root domain in ldap server
-*            ldap server
+*/
-* @param String
+public EmailDataSender(String[] toList, String smtpServer, String ldapAddress, String rootdn) {
-*            root domain in ldap server
-*/
-public EmailDataSender(String[] toList, String smtpServer,
-String ldapAddress, String rootdn) {
 toAddressList = toList;
 smtpServerAddress = smtpServer;
 ldapURL = ldapAddress;
 this.rootdn = rootdn;
 }
-/**
-* Set sender address.
+/**
-*
+* Set sender address.
-* @param String
+*
-*            mail sender address
+* @param String mail sender address
 */
 public void setFrom(String from) {
 this.from = from;
 }
-/**
-* Add current user to recipient list.
+/**
-*
+* Add current user to recipient list.
-*/
+*
-public void addCurrentUserToAddressList() {
+*/
+public void addCurrentUserToAddressList() throws EmailSendException {
 // Create an empty array if needed
-if (toAddressList == null)
+if (toAddressList == null) {
 toAddressList = new String[0];
+}
 try {
-String userEmail;
+String[] tmpToAddressList = Arrays.copyOf(toAddressList, toAddressList.length + 1);
-userEmail = getUserEmail();
+tmpToAddressList[tmpToAddressList.length - 1] = getUserEmail();
-toAddressList = Arrays.copyOf(toAddressList,
+toAddressList = tmpToAddressList;
-toAddressList.length + 1);
+} catch (LDAPException ex) {
-toAddressList[toAddressList.length - 1] = userEmail;
+throw new EmailSendException(ex.getMessage(), ex);
-} catch (javax.mail.internet.AddressException e) {
+}
-return;    //does this so that it passes checkstyle and builds
+}
-} catch (javax.naming.NamingException e) {
-return;    //without it build complains that errors are thrown and not caught
+/**
-//methods are used else where and are caught and exercised.
+* Get recipient address list.
-}
+*
-}
+* @return Recipient address list.
-/**
+*/
-* Get recipient address list.
-*
-* @return
-*       Recipient address list.
-*/
 private InternetAddress[] getToAddressList() {
 int toListLength = 0;
-if (toAddressList != null)
+if (toAddressList != null) {
 toListLength = toAddressList.length;
+}
 InternetAddress[] addressList = new InternetAddress[toListLength];
 try {
-log.debug("getToAddressList:length: "
+log.debug("getToAddressList:length: " + toListLength);
-+ toListLength);
 for (int i = 0; i < toListLength; i++) {
-log.debug("getToAddressList:address:"
+log.debug("getToAddressList:address:" + toAddressList[i]);
-+ toAddressList[i]);
 addressList[i] = new InternetAddress(toAddressList[i]);
 }
-} catch (javax.mail.internet.AddressException aex) {
+}
+catch (AddressException aex) {
 log.error("AddressException: " + aex);
 }
 return addressList;
 }
-/**
-* Send xml data without compression
+/**
-*
+* Send xml data without compression
-* @param String
+*
-*            purpose of this email
+* @param String purpose of this email
-* @param String
+* @param String file to send
-*            file to send
+* @param String mime type
-* @param String
+* @param String subject of email
-*            mime type
+* @param String header of email
-* @param String
+*/
-*            subject of email
+public void sendData(String purpose, File fileToSend, String mimeType,
-* @param String
+String subject, String header) throws EmailSendException {
-*            header of email
-*/
-public void sendData(String purpose, String fileToSend, String mimeType,
-String subject, String header) {
 sendData(purpose, fileToSend, mimeType, subject, header, false);
 }
+/**
-/**
+* Sending the XML data(compressed) through email.
-* Sending the XML data(compressed) through email.
+*
-*
+* @param String purpose of this email
-* @param String
+* @param String file to send
-*            purpose of this email
+* @param String subject of email
-* @param String
+* @param String header of email
-*            file to send
+*/
-* @param String
+public void compresseAndSendData(String purpose, File fileToSend,
-*            subject of email
+String subject, String header) throws EmailSendException {
-* @param String
-*            header of email
-*/
-public void compresseAndSendData(String purpose, String fileToSend,
-String subject, String header) {
 sendData(purpose, fileToSend, null, subject, header, true);
 }
-/**
-* Send xml data
+/**
-*
+* Send xml data
-* @param String
+*
-*            purpose of this email
+* @param String purpose of this email
-* @param String
+* @param String file to send
-*            file to send
+* @param String mime type
-* @param String
+* @param String subject of email
-*            mime type
+* @param String header of mail
-* @param String
+* @param boolean compress data if true
-*            subject of email
+*/
-* @param String
+public void sendData(String purpose, File fileToSend, String mimeType,
-*            header of mail
+String subject, String header, boolean compressData) throws EmailSendException {
-* @param boolean
-*            compress data if true
-*/
-public void sendData(String purpose, String fileToSend, String mimeType,
-String subject, String header, boolean compressData) {
 try {
 log.debug("sendData:Send file: " + fileToSend + " and mimetype: " + mimeType);
-if (fileToSend != null) {
+if (fileToSend != null && fileToSend.exists()) {
 InternetAddress[] toAddresses = getToAddressList();
 Properties props = new Properties();
 if (smtpServerAddress != null) {
 log.debug("sendData:smtp address: " + smtpServerAddress);
 props.setProperty("mail.smtp.host", smtpServerAddress);
 }
 Session mailSession = Session.getDefaultInstance(props, null);
 MimeMessage message = new MimeMessage(mailSession);
-String subjectToSend = subject;
+message.setSubject(subject == null ? "" : subject);
-if (subject == null) {
-subjectToSend = "";
-}
-message.setSubject(subjectToSend);
 MimeMultipart multipart = new MimeMultipart("related");
 BodyPart messageBodyPart = new MimeBodyPart();
 ByteArrayDataSource dataSrc = null;
-String fileName = new File(fileToSend).getName();
+String fileName = fileToSend.getName();
 if (compressData) {
 log.debug("Sending compressed data");
 dataSrc = compressFile(fileToSend);
 dataSrc.setName(fileName + ".gz");
 messageBodyPart.setFileName(fileName + ".gz");
-} else {
+}
+else {
 log.debug("Sending uncompressed data:");
-dataSrc = new ByteArrayDataSource(new FileInputStream(
+dataSrc = new ByteArrayDataSource(new FileInputStream(fileToSend), mimeType);
-new File(fileToSend)), mimeType);
+message.setContent(FileUtils.readFileToString(fileToSend), "text/html");
-message.setContent(FileUtils.readFileToString(new File(
-fileToSend)), "text/html");
 multipart = null;
 }
 String headerToSend = null;
 if (header == null) {
 headerToSend = "";
 multipart.addBodyPart(messageBodyPart); // add to the
 // multipart
 message.setContent(multipart);
 }
 try {
-InternetAddress fromAddress = getFromAddress();
+message.setFrom(getFromAddress());
-message.setFrom(fromAddress);
+}
-} catch (HlmAntLibException e) {
+catch (AddressException e) {
-// We are Ignoring the errors as no need to fail the build.
+throw new EmailSendException("Error retrieving the from address: " + e.getMessage(), e);
-log.debug("Error retrieving current user email address: " + e.getMessage(), e);
+} catch (LDAPException e) {
-} catch (javax.mail.internet.AddressException e) {
+throw new EmailSendException("Error retrieving the from address: " + e.getMessage(), e);
-// We are Ignoring the errors as no need to fail the build.
-log.debug("Error retrieving current user email address: " + e.getMessage(), e);
-} catch (javax.naming.NamingException e) {
-// We are Ignoring the errors as no need to fail the build.
-log.debug("Error retrieving current user email address: " + e.getMessage(), e);
 }
 message.addRecipients(Message.RecipientType.TO, toAddresses);
 log.info("Sending email alert: " + subject);
 Transport.send(message);
 }
-} catch (javax.mail.MessagingException e) {
+} catch (MessagingException e) {
-String errorMessage = e.getMessage();
 String fullErrorMessage = "Failed sending e-mail: " + purpose;
-if (errorMessage != null) {
+if (e.getMessage() != null) {
-fullErrorMessage += " " + errorMessage;
+fullErrorMessage += ": " + e.getMessage();
 }
-} catch (java.io.IOException e) {
+throw new EmailSendException(fullErrorMessage, e);
-String errorMessage = e.getMessage();
+} catch (IOException e) {
 String fullErrorMessage = "Failed sending e-mail: " + purpose;
-if (errorMessage != null) {
+if (e.getMessage() != null) {
-fullErrorMessage += " " + errorMessage;
+fullErrorMessage += ": " + e.getMessage();
 }
 // We are Ignoring the errors as no need to fail the build.
-log.info(fullErrorMessage);
+throw new EmailSendException(fullErrorMessage, e);
 }
 }
 /**
 * GZipping a string.
 *
-* @param data
+* @param data the content to be gzipped.
-*            the content to be gzipped.
+* @param filename the name for the file.
-* @param filename
-*            the name for the file.
 * @return a ByteArrayDataSource.
 */
-protected ByteArrayDataSource compressFile(String fileName)
+protected ByteArrayDataSource compressFile(File fileName) throws IOException {
-throws IOException {
 ByteArrayOutputStream out = new ByteArrayOutputStream();
 GZIPOutputStream gz = new GZIPOutputStream(out);
-BufferedInputStream bufferedInputStream = new BufferedInputStream(
+BufferedInputStream bufferedInputStream = new BufferedInputStream(new FileInputStream(fileName));
-new FileInputStream(new File(fileName)));
 byte[] dataBuffer = new byte[512];
 while ((bufferedInputStream.read(dataBuffer)) != -1) {
 gz.write(dataBuffer);
 }
 gz.close();
 bufferedInputStream.close();
-ByteArrayDataSource dataSrc = new ByteArrayDataSource(
+ByteArrayDataSource dataSrc = new ByteArrayDataSource(out.toByteArray(), "application/x-gzip");
-out.toByteArray(), "application/x-gzip");
 return dataSrc;
 }
-/**
-* Get sender address.
+/**
-*
+* Get sender address.
-* @return
+*
-*       sender address.
+* @return sender address.
-*/
+* @throws AddressException
-private InternetAddress getFromAddress() throws javax.mail.internet.AddressException, javax.naming.NamingException {
+* @throws LDAPException
+*/
+private InternetAddress getFromAddress() throws AddressException, LDAPException {
 if (from != null) {
 return new InternetAddress(from);
 }
 return new InternetAddress(getUserEmail());
 }
 /**
 * Getting user email.
 *
-* @return
+* @return the user email address.
-*    the user email address.
+*/
-*/
+protected String getUserEmail() throws LDAPException {
-protected String getUserEmail() throws javax.mail.internet.AddressException, javax.naming.NamingException {
+if (ldapURL != null) {
-String username = System.getProperty("user.name");
+LDAPHelper helper = new LDAPHelper(this.ldapURL, this.rootdn);
-log.debug("EmailDataSender:getUserEmail:username: " + username);
+String email = helper.getUserAttributeAsString(LDAPHelper.EMAIL_ATTRIBUTE_NAME);
+if (email == null) {
-// Set up environment for creating initial context
+throw new LDAPException("Could not find email for current user. (" + System.getProperty("user.name") + ")");
-Hashtable<String, String> env = new Hashtable<String, String>(11);
+}
-env.put(Context.INITIAL_CONTEXT_FACTORY,
+return email;
-"com.sun.jndi.ldap.LdapCtxFactory");
+}
-env.put(Context.PROVIDER_URL, ldapURL + "/" + rootdn);
+throw new LDAPException("LDAP url is not defined.");
-// Create initial context
-DirContext ctx = new InitialDirContext(env);
-SearchControls controls = new SearchControls();
-controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
-try {
-NamingEnumeration<SearchResult> en = ctx.search("", "uid=" + username, controls);
-if (en.hasMore()) {
-SearchResult sr = en.next();
-if (sr.getAttributes().get("mail") != null) {
-String email = (String) sr.getAttributes().get("mail").get();
-log.debug("getUserEmail:" + email);
-return email;
-}
-}
-} catch (javax.naming.NameNotFoundException ex) {
-throw new HlmAntLibException("Error finding user email for " + username );
-}
-throw new HlmAntLibException("Could not find user email in LDAP.");
 }
 }

changeset 628	7c4a911dc066
parent 588	c7c26511138f