KickJava   Java API By Example, From Geeks To Geeks.

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


1 /********************************************************************************
2  * CruiseControl, a Continuous Integration Toolkit
3  * Copyright (c) 2001-2003, 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
43 import java.io.File JavaDoc;
44
45 /**
46  * Implementation of the Jabber publisher which publishes
47  * a link to the build results via Jabber Instant Messaging framework.
48  *
49  * @see net.sourceforge.cruisecontrol.publishers.JabberPublisher
50  *
51  * @author <a HREF="mailto:jonas_edgeworth@cal.berkeley.edu">Jonas Edgeworth</a>
52  * @version 1.0
53  */
54 public class LinkJabberPublisher extends JabberPublisher {
55
56     private String JavaDoc buildResultsURL;
57
58     public void setBuildResultsURL(String JavaDoc buildResultsURL) {
59         this.buildResultsURL = buildResultsURL;
60     }
61
62     /**
63      * Validate that all the mandatory parameters were specified in order
64      * to properly initial the Jabber client service. Note that this is called
65      * after the configuration file is read.
66      *
67      * @throws CruiseControlException if there was a configuration error.
68      */
69     public void validate() throws CruiseControlException {
70
71         super.validate();
72
73         ValidationHelper.assertIsSet(buildResultsURL, "buildresulturl", this.getClass());
74     }
75
76     /**
77      * Creates the IM message body. This currently creates a message
78      * that is a link to a web page with the details of the build.
79      *
80      * @return <code>String</code> the link that makes up the body of the IM message
81      * @throws CruiseControlException
82      */
83     protected String JavaDoc createMessage(XMLLogHelper logHelper) throws CruiseControlException {
84         String JavaDoc logFileName = logHelper.getLogFileName();
85         String JavaDoc baseLogFileName =
86                 logFileName.substring(
87                         logFileName.lastIndexOf(File.separator) + 1,
88                         logFileName.lastIndexOf("."));
89
90         StringBuffer JavaDoc message = new StringBuffer JavaDoc();
91         message.append("Build results for ");
92         message.append(logHelper.isBuildSuccessful() ? "successful" : "failed");
93         message.append(" build of project ");
94         message.append(logHelper.getProjectName());
95         message.append(": ");
96
97         message.append(buildResultsURL);
98
99         if (buildResultsURL.indexOf("?") == -1) {
100             message.append("?");
101         } else {
102             message.append("&");
103         }
104
105         message.append("log=");
106         message.append(baseLogFileName);
107
108         return message.toString();
109     }
110
111 }
112
Popular Tags