1 package org.apache.maven.plugin.war;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.maven.archiver.MavenArchiver;
23 import org.apache.maven.artifact.Artifact;
24 import org.apache.maven.artifact.DependencyResolutionRequiredException;
25 import org.apache.maven.plugin.MojoExecutionException;
26 import org.apache.maven.plugin.MojoFailureException;
27 import org.apache.maven.plugin.war.util.ClassesPackager;
28 import org.apache.maven.project.MavenProjectHelper;
29 import org.codehaus.plexus.archiver.ArchiverException;
30 import org.codehaus.plexus.archiver.jar.ManifestException;
31 import org.codehaus.plexus.archiver.war.WarArchiver;
32 import org.codehaus.plexus.util.StringUtils;
33
34 import java.io.File;
35 import java.io.IOException;
36 import java.util.Arrays;
37
38
39
40
41
42
43
44
45
46
47
48 public class WarMojo
49 extends AbstractWarMojo
50 {
51
52
53
54
55
56
57 private String outputDirectory;
58
59
60
61
62
63
64
65 private String warName;
66
67
68
69
70
71
72
73 private String classifier;
74
75
76
77
78
79
80
81
82
83 private String packagingExcludes;
84
85
86
87
88
89
90
91
92 private String packagingIncludes;
93
94
95
96
97
98
99 private WarArchiver warArchiver;
100
101
102
103
104 private MavenProjectHelper projectHelper;
105
106
107
108
109
110
111
112 private boolean primaryArtifact = true;
113
114
115
116
117
118
119
120
121
122 private boolean failOnMissingWebXml = true;
123
124
125
126
127
128
129
130
131 private boolean attachClasses = false;
132
133
134
135
136
137
138
139 private String classesClassifier = "classes";
140
141
142
143
144
145
146
147
148
149
150
151 public void execute()
152 throws MojoExecutionException, MojoFailureException
153 {
154 File warFile = getTargetWarFile();
155
156 try
157 {
158 performPackaging( warFile );
159 }
160 catch ( DependencyResolutionRequiredException e )
161 {
162 throw new MojoExecutionException( "Error assembling WAR: " + e.getMessage(), e );
163 }
164 catch ( ManifestException e )
165 {
166 throw new MojoExecutionException( "Error assembling WAR", e );
167 }
168 catch ( IOException e )
169 {
170 throw new MojoExecutionException( "Error assembling WAR", e );
171 }
172 catch ( ArchiverException e )
173 {
174 throw new MojoExecutionException( "Error assembling WAR: " + e.getMessage(), e );
175 }
176 }
177
178
179
180
181
182
183
184
185
186
187
188
189
190 private void performPackaging( File warFile )
191 throws IOException, ArchiverException, ManifestException, DependencyResolutionRequiredException,
192 MojoExecutionException, MojoFailureException
193 {
194 getLog().info( "Packaging webapp" );
195
196 buildExplodedWebapp( getWebappDirectory() );
197
198 MavenArchiver archiver = new MavenArchiver();
199
200 archiver.setArchiver( warArchiver );
201
202 archiver.setOutputFile( warFile );
203
204 getLog().debug(
205 "Excluding " + Arrays.asList( getPackagingExcludes() ) + " from the generated webapp archive." );
206 getLog().debug(
207 "Including " + Arrays.asList( getPackagingIncludes() ) + " in the generated webapp archive." );
208
209 warArchiver.addDirectory( getWebappDirectory(), getPackagingIncludes(), getPackagingExcludes() );
210
211 final File webXmlFile = new File( getWebappDirectory(), "WEB-INF/web.xml" );
212 if ( webXmlFile.exists() )
213 {
214 warArchiver.setWebxml( webXmlFile );
215 }
216 if ( !failOnMissingWebXml )
217 {
218 getLog().debug( "Build won't fail if web.xml file is missing." );
219
220 warArchiver.setIgnoreWebxml( false );
221 }
222
223
224 archiver.createArchive( getProject(), getArchive() );
225
226
227 if ( isAttachClasses() )
228 {
229 ClassesPackager packager = new ClassesPackager();
230 final File classesDirectory = packager.getClassesDirectory( getWebappDirectory() );
231 if ( classesDirectory.exists() )
232 {
233 getLog().info( "Packaging classes" );
234 packager.packageClasses( classesDirectory, getTargetClassesFile(), getJarArchiver(), getProject(),
235 getArchive() );
236 projectHelper.attachArtifact( getProject(), "jar", getClassesClassifier(), getTargetClassesFile() );
237 }
238 }
239
240 String classifier = this.classifier;
241 if ( classifier != null )
242 {
243 projectHelper.attachArtifact( getProject(), "war", classifier, warFile );
244 }
245 else
246 {
247 Artifact artifact = getProject().getArtifact();
248 if ( primaryArtifact )
249 {
250 artifact.setFile( warFile );
251 }
252 else if ( artifact.getFile() == null || artifact.getFile().isDirectory() )
253 {
254 artifact.setFile( warFile );
255 }
256 }
257 }
258
259
260 protected static File getTargetFile( File basedir, String finalName, String classifier, String type )
261 {
262 if ( classifier == null )
263 {
264 classifier = "";
265 }
266 else if ( classifier.trim().length() > 0 && !classifier.startsWith( "-" ) )
267 {
268 classifier = "-" + classifier;
269 }
270
271 return new File( basedir, finalName + classifier + "." + type );
272 }
273
274
275 protected File getTargetWarFile()
276 {
277 return getTargetFile( new File( getOutputDirectory() ), getWarName(), getClassifier(), "war" );
278
279 }
280
281 protected File getTargetClassesFile()
282 {
283 return getTargetFile( new File( getOutputDirectory() ), getWarName(), getClassesClassifier(), "jar" );
284 }
285
286
287
288 public String getClassifier()
289 {
290 return classifier;
291 }
292
293 public void setClassifier( String classifier )
294 {
295 this.classifier = classifier;
296 }
297
298 public String[] getPackagingExcludes()
299 {
300 if ( StringUtils.isEmpty( packagingExcludes ) )
301 {
302 return new String[0];
303 }
304 else
305 {
306 return StringUtils.split( packagingExcludes, "," );
307 }
308 }
309
310 public void setPackagingExcludes( String packagingExcludes )
311 {
312 this.packagingExcludes = packagingExcludes;
313 }
314
315 public String[] getPackagingIncludes()
316 {
317 if ( StringUtils.isEmpty( packagingIncludes ) )
318 {
319 return new String[]{"**"};
320 }
321 else
322 {
323 return StringUtils.split( packagingIncludes, "," );
324 }
325 }
326
327 public void setPackagingIncludes( String packagingIncludes )
328 {
329 this.packagingIncludes = packagingIncludes;
330 }
331
332 public String getOutputDirectory()
333 {
334 return outputDirectory;
335 }
336
337 public void setOutputDirectory( String outputDirectory )
338 {
339 this.outputDirectory = outputDirectory;
340 }
341
342 public String getWarName()
343 {
344 return warName;
345 }
346
347 public void setWarName( String warName )
348 {
349 this.warName = warName;
350 }
351
352 public WarArchiver getWarArchiver()
353 {
354 return warArchiver;
355 }
356
357 public void setWarArchiver( WarArchiver warArchiver )
358 {
359 this.warArchiver = warArchiver;
360 }
361
362 public MavenProjectHelper getProjectHelper()
363 {
364 return projectHelper;
365 }
366
367 public void setProjectHelper( MavenProjectHelper projectHelper )
368 {
369 this.projectHelper = projectHelper;
370 }
371
372 public boolean isPrimaryArtifact()
373 {
374 return primaryArtifact;
375 }
376
377 public void setPrimaryArtifact( boolean primaryArtifact )
378 {
379 this.primaryArtifact = primaryArtifact;
380 }
381
382 public boolean isAttachClasses()
383 {
384 return attachClasses;
385 }
386
387 public void setAttachClasses( boolean attachClasses )
388 {
389 this.attachClasses = attachClasses;
390 }
391
392 public String getClassesClassifier()
393 {
394 return classesClassifier;
395 }
396
397 public void setClassesClassifier( String classesClassifier )
398 {
399 this.classesClassifier = classesClassifier;
400 }
401
402 public boolean isFailOnMissingWebXml()
403 {
404 return failOnMissingWebXml;
405 }
406
407 public void setFailOnMissingWebXml( boolean failOnMissingWebXml )
408 {
409 this.failOnMissingWebXml = failOnMissingWebXml;
410 }
411 }