View Javadoc

1   /**
2    * This file Copyright (c) 2003-2012 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.mail.handlers;
35  
36  import info.magnolia.module.mail.templates.MgnlEmail;
37  
38  import java.util.ArrayList;
39  import java.util.Arrays;
40  
41  import javax.mail.Transport;
42  
43  import org.slf4j.Logger;
44  import org.slf4j.LoggerFactory;
45  
46  
47  /**
48   * This class is meant to allow async emails ... The mail is posted and send. Note that mail success or failure is only
49   * displayed in the logs. Date: Mar 31, 2006 Time: 5:51:38 PM
50   * @author <a href="mailto:niko@macnica.com">Nicolas Modrzyk</a>
51   */
52  public class ThreadedMailHandler implements MgnlMailHandler {
53  
54      Logger log = LoggerFactory.getLogger(ThreadedMailHandler.class);
55  
56      ArrayList<MgnlEmail> emails = new ArrayList<MgnlEmail>();
57  
58      MailThread thread; // can be replaced with a pool of thread someday
59  
60      private ThreadedMailHandler() {
61          this.thread = new MailThread();
62          Thread bb = new Thread(this.thread);
63          bb.start();
64      }
65  
66      @Override
67      protected void finalize() throws Throwable {
68          this.thread.setStop(true);
69          super.finalize();
70      }
71  
72      /**
73       * Prepare the email (format it) and send it.
74       * @param email the email to send
75       * @throws Exception if fails
76       */
77      @Override
78      public void prepareAndSendMail(MgnlEmail email) throws Exception {
79          email.setBodyNotSetFlag(true);
80          synchronized (this) {
81              this.emails.add(email);
82          }
83          this.thread.notify();
84      }
85  
86      /**
87       * Send the email as is, without touching it.
88       * @param email the email to send
89       * @throws Exception if fails
90       */
91      @Override
92      public void sendMail(MgnlEmail email) throws Exception {
93          synchronized (this) {
94              this.emails.add(email);
95          }
96          this.thread.notify();
97      }
98  
99      /**
100      * Thread doing all the job for sending emails and formatting the body.
101      */
102     class MailThread implements Runnable {
103 
104         boolean stop = false;
105 
106         @Override
107         public void run() {
108             while (!this.stop) {
109                 if (ThreadedMailHandler.this.emails.size() == 0) { // nothing to do just sleep
110                     synchronized (this) {
111                         try {
112                             wait();
113                         }
114                         catch (InterruptedException e) {
115                             ThreadedMailHandler.this.log.info("Mail Thread was interrupted");
116                         }
117                     }
118                 }
119                 else {
120                     MgnlEmail email = null;
121                     synchronized (this) {
122                         if (ThreadedMailHandler.this.emails.size() > 0) {
123                             email = ThreadedMailHandler.this.emails.remove(0);
124                         }
125                     }
126                     if (email != null) {
127                         try {
128                             if (email.isBodyNotSetFlag()) {
129                              //   email.setBody();
130                             }
131                             try {
132                                 Transport.send(email);
133                                 ThreadedMailHandler.this.log.info("Mail has been sent to: ["
134                                     + Arrays.asList(email.getAllRecipients())
135                                     + "]");
136                             }
137                             catch (Exception e) {
138                                 ThreadedMailHandler.this.log.error("Email to: ["
139                                     + Arrays.asList(email.getAllRecipients())
140                                     + "] was not sent because of an error", e);
141                             }
142                         }
143                         catch (Exception e) {
144                             e.printStackTrace();
145                         }
146                     }
147                 }
148 
149             }
150         }
151 
152         public boolean isStop() {
153             return this.stop;
154         }
155 
156         public void setStop(boolean stop) {
157             this.stop = stop;
158             this.notify();
159         }
160     }
161 }