KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > cruisecontrol > publishers > LinkEmailPublisher


1 /********************************************************************************
2  * CruiseControl, a Continuous Integration Toolkit
3  * Copyright (c) 2001, ThoughtWorks, Inc.
4  * 651 W Washington Ave. Suite 600
5  * Chicago, IL 60661 USA
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * + Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * + Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  *
20  * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
21  * names of its contributors may be used to endorse or promote
22  * products derived from this software without specific prior
23  * written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  ********************************************************************************/
37 package net.sourceforge.cruisecontrol.publishers;
38
39 import net.sourceforge.cruisecontrol.CruiseControlException;
40 import net.sourceforge.cruisecontrol.util.ValidationHelper;
41 import net.sourceforge.cruisecontrol.util.XMLLogHelper;
42 import org.apache.log4j.Logger;
43
44 import java.io.File JavaDoc;
45
46 /**
47  * Concrete implementation of the <code>EmailPublisher</code> abstract class. This class handles the simplest
48  * implementation where the message body is just a link to a web page detailing the build.
49  *
50  * @author alden almagro, ThoughtWorks, Inc. 2002
51  */
52 public class LinkEmailPublisher extends EmailPublisher {
53
54     private static final Logger LOG = Logger.getLogger(LinkEmailPublisher.class);
55
56     /**
57      * Creates the email message body. This implementation of <code>EmailPublisher</code> just creates a message
58      * that is a link to a web page with the details of the build.
59      *
60      * @return <code>String</code> the link that makes up the body of the email message
61      */
62     protected String JavaDoc createMessage(XMLLogHelper logHelper) {
63         String JavaDoc logFileName = "";
64         try {
65             logFileName = logHelper.getLogFileName();
66         } catch (CruiseControlException e) {
67             LOG.error("", e);
68         }
69         String JavaDoc baseLogFileName =
70             logFileName.substring(
71                 logFileName.lastIndexOf(File.separator) + 1,
72                 logFileName.lastIndexOf("."));
73
74         StringBuffer JavaDoc message = new StringBuffer JavaDoc();
75         message.append("View results here -> ");
76
77         String JavaDoc buildResultsURL = getBuildResultsURL();
78         message.append(buildResultsURL);
79
80         if (buildResultsURL.indexOf("?") == -1) {
81             message.append("?");
82         } else {
83             message.append("&");
84         }
85
86         message.append("log=");
87         message.append(baseLogFileName);
88         
89         return message.toString();
90     }
91
92     /*
93     * Called after the configuration is read to make sure that all the
94     * mandatory parameters were specified..
95     *
96     * @throws CruiseControlException if there was a configuration error.
97      */
98     public void validate() throws CruiseControlException {
99         ValidationHelper.assertIsSet(getBuildResultsURL(), "buildresulturl", this.getClass());
100         super.validate();
101     }
102
103 }
Popular Tags