MailChimp and Java Integration – Part 1

package com.othenos.mailchimp;
 
public interface IMailChimpHandler {
	public int initializeMailChimpList(int companyId);
	public boolean addUser(int contactId);
	public boolean updateUser(int contactId, String oldEmail);
	public boolean deleteUser(String oldEmail);
}

public class MailChimpHandler implements IMailChimpHandler {
    private final Log log = LogFactory.getLog(getClass());
    // API Key - see http://admin.mailchimp.com/account/api or run login() once
    private String apiKey = "put your api key info here";
    // A List Id to run examples against. use lists() to view all
    // Also, login to MC account, go to List, then List Tools, and look for the
    // List ID entry
    private String listId = "put your list ID here";
    // Instance of the MailChimpServices
    private IMailChimpServices mcServices = null;
    // Flag indicating status of our connection to MailChimp
    private boolean connectionStatus;
    // Class to get the attributes associated with a company from database
    private ICompanyAttributesDao companyAttributesDao;
 
    public MailChimpHandler() {
        connectionStatus = false;
    }
 
    /**
    * prepare an instance of the MailChimpServices and determine
    * if we can connect using our apiKey.
    */
    private void initialize() {
        mcServices = MailChimpServiceFactory.getMailChimpServices();
        final String ping = mcServices.ping(apiKey);
        if (IMailChimpServices.PING_SUCCESS.equals(ping)) {
            log.info("MailChimp connection pinged successfully");
            connectionStatus = true;
        } else {
            log.error("Failed to ping MailChimp, response: " + ping);
        }
    }
 
    /**
    * test the connection to see if it is still good
    * @return result
    */
    private boolean testConnection(){
        if(mcServices != null)
            return IMailChimpServices.PING_SUCCESS.equals(mcServices.ping(apiKey));
        else
            return false;
    }
 
     /**
     * Performs the initialization of the mail chimp list by adding
     * all the appropriate customer contacts to the list
     * @param companyId (this is optional and only here because my application needs it. Yours almost certainly won't need it)
     * @return number of successful insertions
     */
     public int initializeMailChimpList(int companyId){
         int listSubscribe = 0;
         int listFailure = 0;
 
         // insure we can connect to the server, if not then re-initialize
         if (testConnection() == false){
             log.info("Attempting to re-connect to MailChimp");
             initialize();
         }
 
         // if we have confirmed we can connect OK, proceed
         if (connectedStatus) {
             // This is my way of getting all the contacts I want to add to the list
             // You will come up with your own way of getting your contacts
             List<CustomerContact> contacts = customerContactDao.getMailChimpCustomerContacts(companyId);
             // Instantiate an ArrayList to hold all the contact info to send
             // ArrayList seems to be the preferred data structure for sending and receiving array information
             List<Map<String, String>> chimps = new ArrayList<Map<String,String>>();
             // For each of our contacts, build a HashMap of MailChimp tags and add it to the list
             for(CustomerContact contact : contacts){
                 Map<String, String> chimp = new HashMap<String, String>();
                 chimp.put("FNAME", contact.getFirstName());
                 chimp.put("LNAME", contact.getLastName());
                 chimp.put("EMAIL", contact.getEmail());
                 chimp.put("EMAIL_TYPE", "html");             // define the mail type to be HTML
                 chimps.add(chimp);
             }
             // Now that we have the ArrayList populated, attempt to send it to MailChimp
             try {
                 // attempt a batch update of the list using mcServices listBatchSubscribe method
                 // the last 3 arguments have to do with double-optin, updating existing and replacing interests. All false for us.
                 HashMap<String, Object> results = mcServices.listBatchSubscribe(apiKey, listId, chimps, false, false, false);
                 // the results come back as a HashMap with three entries, success_count, error_count and errors
                 listSubscribe = (Integer)results.get("success_count");
                 listFailure = (Integer)results.get("error_count");
                 log.info("Mail Chimp results : " + listSubscribe + " inserted and " + listFailure + " errors.");
                 // interpret the results to see what went good and bad
                 // The errors comes back as an array of Objects
                 Object[] errors = (Object[])results.get("errors");
                 createLogFile(errors, companyId);
                 // and update the good contacts to indicate they have been subscribed
                 // We have opted to update our contact list to indicate that the contacts got subscribe OK
                 // This is certainly optional
                 customerContactDao.markContactsSubscribed(companyId);
                 // be sure and mark contacts that have errors as not subscribed
                 // Again, we have opted to mark our contacts that failed to get subscribed
                 // This is optional as well
                 for(Object item : errors){
                     HashMap<String,Object> result = (HashMap<String,Object>)item;
                     HashMap<String,Object> row = (HashMap<String,Object>)result.get("row");
                     String fName = (String)row.get("FNAME");
                     String lName = (String)row.get("LNAME");
                     String email = (String)row.get("EMAIL");
                     customerContactDao.markContactsNotSubscribed(fName, lName, email);
                 }
 
             } catch (MailChimpServiceException mcse) {
                 log.error("Error in adding user to list. " + mcse.getMessage());
                 mcse.printStackTrace();
             } catch(Exception e){
                 log.error("Error in adding user to list. " + e.getMessage());
                 e.printStackTrace();
              }
         }else
             log.info("Could not add user because could not connect to MailChimp");
 
         return listSubscribe;
     }
 
    /**
    * add a new contact to MailChimp
    * @param contactId
    * return result
    */
    public boolean addUser(int contactId){
        // TODO Complete
        return false;
    }
 
    /**
    * update an existing contact to MailChimp
    * @param contactId
    * @param oldEmail
    * return result
    */
    public boolean updateUser(int contactId, String oldEmail){
        // TODO Complete
        return false;
    }
 
    /**
    * delete a contact from MailChimp
    * @param oldEmail
    * return result
    */
    public boolean deleteUser(String oldEmail){
        // TODO Complete
        return false;
    }
 
}