1 package org.apache.maven.werkz.jelly;
2
3 /* ====================================================================
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ====================================================================
19 */
20
21 /*
22 $Id: GoalTag.java 517014 2007-03-11 21:15:50Z ltheussl $
23
24 Copyright 2002 (C) The Werken Company. All Rights Reserved.
25
26 Redistribution and use of this software and associated documentation
27 ("Software"), with or without modification, are permitted provided
28 that the following conditions are met:
29
30 1. Redistributions of source code must retain copyright
31 statements and notices. Redistributions must also contain a
32 copy of this document.
33
34 2. Redistributions in binary form must reproduce the
35 above copyright notice, this list of conditions and the
36 following disclaimer in the documentation and/or other
37 materials provided with the distribution.
38
39 3. The name "werkz" must not be used to endorse or promote
40 products derived from this Software without prior written
41 permission of The Werken Company. For written permission,
42 please contact bob@werken.com.
43
44 4. Products derived from this Software may not be called "werkz"
45 nor may "werkz" appear in their names without prior written
46 permission of The Werken Company. "werkz" is a registered
47 trademark of The Werken Company.
48
49 5. Due credit should be given to "the werkz project"
50 ( http://werkz.werken.com/ ).
51
52 THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
53 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
54 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
55 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
56 THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
57 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
58 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
59 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
61 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
62 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
63 OF THE POSSIBILITY OF SUCH DAMAGE.
64
65 */
66
67 import java.util.StringTokenizer;
68
69 import org.apache.commons.jelly.JellyTagException;
70 import org.apache.commons.jelly.XMLOutput;
71 import org.apache.commons.logging.Log;
72 import org.apache.commons.logging.LogFactory;
73 import org.apache.maven.werkz.Action;
74 import org.apache.maven.werkz.CyclicGoalChainException;
75 import org.apache.maven.werkz.DefaultAction;
76 import org.apache.maven.werkz.Goal;
77 import org.apache.maven.werkz.Session;
78
79 /**
80 * Implements a <target> tag which is similar to the Ant equivalent tag
81 * but is based on the Werkz goal engine.
82 *
83 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
84 * @version $Revision: 1.3 $
85 */
86 public class GoalTag
87 extends WerkzTagSupport
88 {
89
90 /** The Log to which logging calls will be made. */
91 private static final Log LOGGER = LogFactory.getLog( GoalTag.class );
92
93 /** the name of the target */
94 private String name;
95
96 private String prereqs;
97
98 private String description;
99
100 public GoalTag()
101 {
102 }
103
104 // Tag interface
105 //-------------------------------------------------------------------------
106
107 /**
108 * Evaluate the body to register all the various goals and pre/post conditions
109 * then run all the current targets
110 */
111 public void doTag( final XMLOutput output )
112 throws JellyTagException
113 {
114
115 LOGGER.debug( "doTag(..):" + name );
116
117 Goal goal = getProject().getGoal( getName(), true );
118
119 goal.setDescription( this.description );
120 try
121 {
122 addPrereqs( goal );
123 }
124 catch ( CyclicGoalChainException e )
125 {
126 throw new JellyTagException( e );
127 }
128
129 Action action;
130
131 action = getAction();
132
133 if ( action == null )
134 {
135 action = new DefaultAction()
136 {
137 public void performAction( Session session )
138 throws Exception
139 {
140 performAction();
141 }
142
143 public void performAction()
144 throws Exception
145 {
146 LOGGER.debug( "Running action of target: " + getName() );
147 invokeBody( output );
148 }
149 };
150 }
151
152 goal.setAction( action );
153 }
154
155 // Properties
156 //-------------------------------------------------------------------------
157 /**
158 * @return the name of the target
159 */
160 public String getName()
161 {
162 return name;
163 }
164
165 /**
166 * Sets the name of the target
167 */
168 public void setName( String name )
169 {
170 LOGGER.debug( "setName(" + name + ")" );
171 this.name = name;
172 }
173
174 public void setPrereqs( String prereqs )
175 {
176 this.prereqs = prereqs;
177 }
178
179 public String getPrereqs()
180 {
181 return this.prereqs;
182 }
183
184 public void setDescription( String description )
185 {
186 this.description = description;
187 }
188
189 protected void addPrereqs( Goal goal )
190 throws CyclicGoalChainException
191 {
192 String prereqs = getPrereqs();
193
194 if ( prereqs == null )
195 {
196 return;
197 }
198
199 StringTokenizer tokens = new StringTokenizer( getPrereqs(), "," );
200
201 String eachToken = null;
202 Goal eachPrereq = null;
203
204 while ( tokens.hasMoreTokens() )
205 {
206 eachToken = tokens.nextToken().trim();
207
208 eachPrereq = getProject().getGoal( eachToken, true );
209
210 goal.addPrecursor( eachPrereq );
211 }
212 }
213
214 /**
215 * Subclasses can override this template method to provide a
216 * custom <code>Action</code> implementation. This scenerio will
217 * most likely come into play when you have also created a custom
218 * <code>Session</code> implementation that can be used to provide
219 * parameters during the attainment of a <code>Goal</code>.
220 */
221 protected Action getAction()
222 {
223 return null;
224 }
225 }