mirror of https://github.com/apache/maven.git
PR: MNG-1037
Submitted by: Allan Ramirez Reviewed by: Brett Porter add exploded and inplace goals (applied with modifications to better utilise base class and use shared default excludes) git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@307363 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter
parent
24682f85e8
commit
49fd01a9a4
|
|
@ -2,7 +2,7 @@
|
|||
<parent>
|
||||
<artifactId>maven-plugin-parent</artifactId>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<version>2.0-beta-1</version>
|
||||
<version>2.0-beta-4-SNAPSHOT</version>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>maven-war-plugin</artifactId>
|
||||
|
|
@ -15,6 +15,10 @@
|
|||
<artifactId>maven-archiver</artifactId>
|
||||
<version>2.0-beta-3</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.codehaus.plexus</groupId>
|
||||
<artifactId>plexus-utils</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven</groupId>
|
||||
<artifactId>maven-artifact</artifactId>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,318 @@
|
|||
package org.apache.maven.plugin.war;
|
||||
|
||||
/*
|
||||
* Copyright 2001-2005 The Apache Software Foundation.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import org.apache.maven.artifact.Artifact;
|
||||
import org.apache.maven.plugin.AbstractMojo;
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
import org.apache.maven.project.MavenProject;
|
||||
import org.codehaus.plexus.util.DirectoryScanner;
|
||||
import org.codehaus.plexus.util.FileUtils;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
public abstract class AbstractWarMojo
|
||||
extends AbstractMojo
|
||||
{
|
||||
/**
|
||||
* The maven project.
|
||||
*
|
||||
* @parameter expression="${project}"
|
||||
* @required
|
||||
* @readonly
|
||||
*/
|
||||
private MavenProject project;
|
||||
|
||||
/**
|
||||
* The directory containing generated classes.
|
||||
*
|
||||
* @parameter expression="${project.build.outputDirectory}"
|
||||
* @required
|
||||
* @readonly
|
||||
*/
|
||||
private File classesDirectory;
|
||||
|
||||
/**
|
||||
* The directory where the webapp is built.
|
||||
*
|
||||
* @parameter expression="${project.build.directory}/${project.build.finalName}"
|
||||
* @required
|
||||
*/
|
||||
private File webappDirectory;
|
||||
|
||||
/**
|
||||
* Single directory for extra files to include in the WAR.
|
||||
*
|
||||
* @parameter expression="${basedir}/src/main/webapp"
|
||||
* @required
|
||||
*/
|
||||
private File warSourceDirectory;
|
||||
|
||||
/**
|
||||
* The path to the web.xml file to use.
|
||||
*
|
||||
* @parameter expression="${maven.war.webxml}"
|
||||
*/
|
||||
private String webXml;
|
||||
|
||||
public static final String WEB_INF = "WEB-INF";
|
||||
|
||||
/**
|
||||
* The comma separated list of tokens to include in the WAR.
|
||||
* Default is '**'.
|
||||
*
|
||||
* @parameter alias="includes"
|
||||
*/
|
||||
private String warSourceIncludes = "**";
|
||||
|
||||
/**
|
||||
* The comma separated list of tokens to exclude from the WAR.
|
||||
*
|
||||
* @parameter alias="excludes"
|
||||
*/
|
||||
private String warSourceExcludes;
|
||||
|
||||
private static final String[] EMPTY_STRING_ARRAY = {};
|
||||
|
||||
public abstract void execute()
|
||||
throws MojoExecutionException;
|
||||
|
||||
public MavenProject getProject()
|
||||
{
|
||||
return project;
|
||||
}
|
||||
|
||||
public void setProject( MavenProject project )
|
||||
{
|
||||
this.project = project;
|
||||
}
|
||||
|
||||
public File getClassesDirectory()
|
||||
{
|
||||
return classesDirectory;
|
||||
}
|
||||
|
||||
public void setClassesDirectory( File classesDirectory )
|
||||
{
|
||||
this.classesDirectory = classesDirectory;
|
||||
}
|
||||
|
||||
public File getWebappDirectory()
|
||||
{
|
||||
return webappDirectory;
|
||||
}
|
||||
|
||||
public void setWebappDirectory( File webappDirectory )
|
||||
{
|
||||
this.webappDirectory = webappDirectory;
|
||||
}
|
||||
|
||||
public File getWarSourceDirectory()
|
||||
{
|
||||
return warSourceDirectory;
|
||||
}
|
||||
|
||||
public void setWarSourceDirectory( File warSourceDirectory )
|
||||
{
|
||||
this.warSourceDirectory = warSourceDirectory;
|
||||
}
|
||||
|
||||
public String getWebXml()
|
||||
{
|
||||
return webXml;
|
||||
}
|
||||
|
||||
public void setWebXml( String webXml )
|
||||
{
|
||||
this.webXml = webXml;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string array of the excludes to be used
|
||||
* when assembling/copying the war.
|
||||
*
|
||||
* @return an array of tokens to exclude
|
||||
*/
|
||||
protected String[] getExcludes()
|
||||
{
|
||||
List excludeList = FileUtils.getDefaultExcludesAsList();
|
||||
if ( warSourceExcludes != null && !"".equals( warSourceExcludes ) )
|
||||
{
|
||||
excludeList.add( warSourceExcludes );
|
||||
}
|
||||
|
||||
// if webXML is specified, omit the one in the source directory
|
||||
if ( getWebXml() != null && !"".equals( getWebXml() ) )
|
||||
{
|
||||
excludeList.add( "**/" + WEB_INF + "/web.xml" );
|
||||
}
|
||||
|
||||
return (String[]) excludeList.toArray( EMPTY_STRING_ARRAY );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string array of the includes to be used
|
||||
* when assembling/copying the war.
|
||||
*
|
||||
* @return an array of tokens to include
|
||||
*/
|
||||
protected String[] getIncludes()
|
||||
{
|
||||
return new String[]{warSourceIncludes};
|
||||
}
|
||||
|
||||
public void buildExplodedWebapp( File webappDirectory )
|
||||
throws MojoExecutionException
|
||||
{
|
||||
getLog().info( "Exploding webapp..." );
|
||||
|
||||
webappDirectory.mkdirs();
|
||||
|
||||
File webinfDir = new File( webappDirectory, WEB_INF );
|
||||
|
||||
webinfDir.mkdirs();
|
||||
|
||||
try
|
||||
{
|
||||
copyResources( getWarSourceDirectory(), webappDirectory, getWebXml() );
|
||||
|
||||
buildWebapp( getProject(), webappDirectory );
|
||||
}
|
||||
catch ( IOException e )
|
||||
{
|
||||
throw new MojoExecutionException( "Could not explode webapp...", e );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies webapp resources from the specified directory.
|
||||
* <p/>
|
||||
* Note that the <tt>webXml</tt> parameter could be null and may
|
||||
* specify a file which is not named <tt>web.xml<tt>. If the file
|
||||
* exists, it will be copied to the <tt>META-INF</tt> directory and
|
||||
* renamed accordingly.
|
||||
*
|
||||
* @param sourceDirectory the source directory
|
||||
* @param webappDirectory the target directory
|
||||
* @param webXml the path to a custom web.xml
|
||||
* @throws java.io.IOException if an error occured while copying resources
|
||||
*/
|
||||
public void copyResources( File sourceDirectory, File webappDirectory, String webXml )
|
||||
throws IOException
|
||||
{
|
||||
if ( !sourceDirectory.equals( webappDirectory ) )
|
||||
{
|
||||
getLog().info( "Copy webapp resources to " + webappDirectory.getAbsolutePath() );
|
||||
if ( getWarSourceDirectory().exists() )
|
||||
{
|
||||
String[] fileNames = getWarFiles( sourceDirectory );
|
||||
for ( int i = 0; i < fileNames.length; i++ )
|
||||
{
|
||||
FileUtils.copyFile( new File( sourceDirectory, fileNames[i] ),
|
||||
new File( webappDirectory, fileNames[i] ) );
|
||||
}
|
||||
}
|
||||
|
||||
if ( webXml != null && !"".equals( webXml ) )
|
||||
{
|
||||
//rename to web.xml
|
||||
File webinfDir = new File( webappDirectory, WEB_INF );
|
||||
FileUtils.copyFile( new File( webXml ), new File( webinfDir, "/web.xml" ) );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the webapp for the specified project.
|
||||
* <p/>
|
||||
* Classes, libraries and tld files are copied to
|
||||
* the <tt>webappDirectory</tt> during this phase.
|
||||
*
|
||||
* @param project the maven project
|
||||
* @param webappDirectory
|
||||
* @throws java.io.IOException if an error occured while building the webapp
|
||||
*/
|
||||
public void buildWebapp( MavenProject project, File webappDirectory )
|
||||
throws IOException
|
||||
{
|
||||
getLog().info( "Assembling webapp " + project.getArtifactId() + " in " + webappDirectory );
|
||||
|
||||
File libDirectory = new File( webappDirectory, WEB_INF + "/lib" );
|
||||
|
||||
File tldDirectory = new File( webappDirectory, WEB_INF + "/tld" );
|
||||
|
||||
File webappClassesDirectory = new File( webappDirectory, WEB_INF + "/classes" );
|
||||
|
||||
if ( getClassesDirectory().exists() )
|
||||
{
|
||||
FileUtils.copyDirectoryStructure( getClassesDirectory(), webappClassesDirectory );
|
||||
}
|
||||
|
||||
Set artifacts = project.getArtifacts();
|
||||
|
||||
for ( Iterator iter = artifacts.iterator(); iter.hasNext(); )
|
||||
{
|
||||
Artifact artifact = (Artifact) iter.next();
|
||||
|
||||
// TODO: utilise appropriate methods from project builder
|
||||
// TODO: scope handler
|
||||
// Include runtime and compile time libraries
|
||||
if ( !Artifact.SCOPE_PROVIDED.equals( artifact.getScope() ) &&
|
||||
!Artifact.SCOPE_TEST.equals( artifact.getScope() ) )
|
||||
{
|
||||
String type = artifact.getType();
|
||||
if ( "tld".equals( type ) )
|
||||
{
|
||||
FileUtils.copyFileToDirectory( artifact.getFile(), tldDirectory );
|
||||
}
|
||||
else if ( "jar".equals( type ) || "ejb".equals( type ) || "ejb-client".equals( type ) )
|
||||
{
|
||||
FileUtils.copyFileToDirectory( artifact.getFile(), libDirectory );
|
||||
}
|
||||
else
|
||||
{
|
||||
getLog().debug( "Skipping artifact of type " + type + " for WEB-INF/lib" );
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of filenames that should be copied
|
||||
* over to the destination directory.
|
||||
*
|
||||
* @param sourceDir the directory to be scanned
|
||||
* @return the array of filenames, relative to the sourceDir
|
||||
*/
|
||||
private String[] getWarFiles( File sourceDir )
|
||||
{
|
||||
DirectoryScanner scanner = new DirectoryScanner();
|
||||
scanner.setBasedir( sourceDir );
|
||||
scanner.setExcludes( getExcludes() );
|
||||
scanner.addDefaultExcludes();
|
||||
|
||||
scanner.setIncludes( getIncludes() );
|
||||
|
||||
scanner.scan();
|
||||
|
||||
return scanner.getIncludedFiles();
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
package org.apache.maven.plugin.war;
|
||||
|
||||
/*
|
||||
* Copyright 2001-2005 The Apache Software Foundation.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
|
||||
/**
|
||||
* Generate the exploded webapp
|
||||
*
|
||||
* @goal exploded
|
||||
* @phase package
|
||||
* @requiresDependencyResolution runtime
|
||||
*/
|
||||
public class WarExplodedMojo
|
||||
extends AbstractWarMojo
|
||||
{
|
||||
public void execute() throws MojoExecutionException
|
||||
{
|
||||
buildExplodedWebapp( getWebappDirectory(), getWebappDirectory() );
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
package org.apache.maven.plugin.war;
|
||||
|
||||
/*
|
||||
* Copyright 2001-2005 The Apache Software Foundation.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
|
||||
/**
|
||||
* Generates webapp in the source directory
|
||||
*
|
||||
* @goal inplace
|
||||
* @requiresDependencyResolution runtime
|
||||
*/
|
||||
public class WarInPlaceMojo
|
||||
extends AbstractWarMojo
|
||||
{
|
||||
public void execute() throws MojoExecutionException
|
||||
{
|
||||
getLog().info( "Generating webapp in source directory... " + getWarSourceDirectory() );
|
||||
|
||||
buildExplodedWebapp( getWarSourceDirectory() );
|
||||
}
|
||||
}
|
||||
|
|
@ -18,23 +18,15 @@ package org.apache.maven.plugin.war;
|
|||
|
||||
import org.apache.maven.archiver.MavenArchiveConfiguration;
|
||||
import org.apache.maven.archiver.MavenArchiver;
|
||||
import org.apache.maven.artifact.Artifact;
|
||||
import org.apache.maven.artifact.DependencyResolutionRequiredException;
|
||||
import org.apache.maven.plugin.AbstractMojo;
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
import org.apache.maven.project.MavenProject;
|
||||
import org.codehaus.plexus.archiver.ArchiverException;
|
||||
import org.codehaus.plexus.archiver.jar.ManifestException;
|
||||
import org.codehaus.plexus.archiver.war.WarArchiver;
|
||||
import org.codehaus.plexus.util.DirectoryScanner;
|
||||
import org.codehaus.plexus.util.FileUtils;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
|
||||
/**
|
||||
* Build a war/webapp.
|
||||
|
|
@ -46,36 +38,8 @@ import java.util.Set;
|
|||
* @requiresDependencyResolution runtime
|
||||
*/
|
||||
public class WarMojo
|
||||
extends AbstractMojo
|
||||
extends AbstractWarMojo
|
||||
{
|
||||
public static final String WEB_INF = "WEB-INF";
|
||||
|
||||
/**
|
||||
* The mode to use. Possible values are: war (default), inplace
|
||||
* and exploded.
|
||||
*
|
||||
* @parameter expression="${mode}"
|
||||
*/
|
||||
private String mode = "war";
|
||||
|
||||
/**
|
||||
* The maven project.
|
||||
*
|
||||
* @parameter expression="${project}"
|
||||
* @required
|
||||
* @readonly
|
||||
*/
|
||||
private MavenProject project;
|
||||
|
||||
/**
|
||||
* The directory containing generated classes.
|
||||
*
|
||||
* @parameter expression="${project.build.outputDirectory}"
|
||||
* @required
|
||||
* @readonly
|
||||
*/
|
||||
private File classesDirectory;
|
||||
|
||||
/**
|
||||
* The directory for the generated WAR.
|
||||
*
|
||||
|
|
@ -84,44 +48,6 @@ public class WarMojo
|
|||
*/
|
||||
private String outputDirectory;
|
||||
|
||||
/**
|
||||
* The directory where the webapp is built.
|
||||
*
|
||||
* @parameter expression="${project.build.directory}/${project.build.finalName}"
|
||||
* @required
|
||||
*/
|
||||
private File webappDirectory;
|
||||
|
||||
/**
|
||||
* Single directory for extra files to include in the WAR.
|
||||
*
|
||||
* @parameter expression="${basedir}/src/main/webapp"
|
||||
* @required
|
||||
*/
|
||||
private File warSourceDirectory;
|
||||
|
||||
/**
|
||||
* The comma separated list of tokens to include in the WAR.
|
||||
* Default is '**'.
|
||||
*
|
||||
* @parameter alias="includes"
|
||||
*/
|
||||
private String warSourceIncludes = "**";
|
||||
|
||||
/**
|
||||
* The comma separated list of tokens to exclude from the WAR.
|
||||
*
|
||||
* @parameter alias="excludes"
|
||||
*/
|
||||
private String warSourceExcludes;
|
||||
|
||||
/**
|
||||
* The path to the web.xml file to use.
|
||||
*
|
||||
* @parameter expression="${maven.war.webxml}"
|
||||
*/
|
||||
private String webXml;
|
||||
|
||||
/**
|
||||
* The name of the generated war.
|
||||
*
|
||||
|
|
@ -145,141 +71,6 @@ public class WarMojo
|
|||
*/
|
||||
private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();
|
||||
|
||||
private static final String[] EMPTY_STRING_ARRAY = {};
|
||||
|
||||
|
||||
/**
|
||||
* Copies webapp resources from the specified directory.
|
||||
* <p/>
|
||||
* Note that the <tt>webXml</tt> parameter could be null and may
|
||||
* specify a file which is not named <tt>web.xml<tt>. If the file
|
||||
* exists, it will be copied to the <tt>META-INF</tt> directory and
|
||||
* renamed accordingly.
|
||||
*
|
||||
* @param sourceDirectory the source directory
|
||||
* @param webappDirectory the target directory
|
||||
* @param webXml the path to a custom web.xml
|
||||
* @throws IOException if an error occured while copying resources
|
||||
*/
|
||||
public void copyResources( File sourceDirectory, File webappDirectory, String webXml )
|
||||
throws IOException
|
||||
{
|
||||
if ( !sourceDirectory.equals( webappDirectory ) )
|
||||
{
|
||||
getLog().info( "Copy webapp resources to " + webappDirectory.getAbsolutePath() );
|
||||
|
||||
if ( warSourceDirectory.exists() )
|
||||
{
|
||||
String[] fileNames = getWarFiles( sourceDirectory );
|
||||
for ( int i = 0; i < fileNames.length; i++ )
|
||||
{
|
||||
FileUtils.copyFile( new File( sourceDirectory, fileNames[i] ),
|
||||
new File( webappDirectory, fileNames[i] ) );
|
||||
}
|
||||
}
|
||||
|
||||
if ( webXml != null && !"".equals( webXml ) )
|
||||
{
|
||||
//rename to web.xml
|
||||
File webinfDir = new File( webappDirectory, WEB_INF );
|
||||
FileUtils.copyFile( new File( webXml ), new File( webinfDir, "/web.xml" ) );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the webapp for the specified project.
|
||||
* <p/>
|
||||
* Classes, libraries and tld files are copied to
|
||||
* the <tt>webappDirectory</tt> during this phase.
|
||||
*
|
||||
* @param project the maven project
|
||||
* @throws IOException if an error occured while building the webapp
|
||||
*/
|
||||
public void buildWebapp( MavenProject project )
|
||||
throws IOException
|
||||
{
|
||||
getLog().info( "Assembling webapp " + project.getArtifactId() + " in " + webappDirectory );
|
||||
|
||||
File libDirectory = new File( webappDirectory, WEB_INF + "/lib" );
|
||||
|
||||
File tldDirectory = new File( webappDirectory, WEB_INF + "/tld" );
|
||||
|
||||
File webappClassesDirectory = new File( webappDirectory, WEB_INF + "/classes" );
|
||||
|
||||
if ( classesDirectory.exists() )
|
||||
{
|
||||
FileUtils.copyDirectoryStructure( classesDirectory, webappClassesDirectory );
|
||||
}
|
||||
|
||||
Set artifacts = project.getArtifacts();
|
||||
|
||||
for ( Iterator iter = artifacts.iterator(); iter.hasNext(); )
|
||||
{
|
||||
Artifact artifact = (Artifact) iter.next();
|
||||
|
||||
// TODO: utilise appropriate methods from project builder
|
||||
// TODO: scope handler
|
||||
// Include runtime and compile time libraries
|
||||
if ( !Artifact.SCOPE_PROVIDED.equals( artifact.getScope() ) &&
|
||||
!Artifact.SCOPE_TEST.equals( artifact.getScope() ) )
|
||||
{
|
||||
String type = artifact.getType();
|
||||
if ( "tld".equals( type ) )
|
||||
{
|
||||
FileUtils.copyFileToDirectory( artifact.getFile(), tldDirectory );
|
||||
}
|
||||
else if ( "jar".equals( type ) || "ejb".equals( type ) || "ejb-client".equals( type ) )
|
||||
{
|
||||
FileUtils.copyFileToDirectory( artifact.getFile(), libDirectory );
|
||||
}
|
||||
else
|
||||
{
|
||||
getLog().debug( "Skipping artifact of type " + type + " for WEB-INF/lib" );
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates and exploded webapp.
|
||||
* <p/>
|
||||
* This mode is invoked when the <tt>mode</tt> parameter has a value
|
||||
* of <tt>exploded</tt>.
|
||||
*
|
||||
* @throws IOException if an error occured while building the webapp
|
||||
*/
|
||||
public void generateExplodedWebapp()
|
||||
throws IOException
|
||||
{
|
||||
webappDirectory.mkdirs();
|
||||
|
||||
File webinfDir = new File( webappDirectory, WEB_INF );
|
||||
|
||||
webinfDir.mkdirs();
|
||||
|
||||
copyResources( warSourceDirectory, webappDirectory, webXml );
|
||||
|
||||
buildWebapp( project );
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates the webapp in the source directory.
|
||||
* <p/>
|
||||
* This mode is invoked when the <tt>mode</tt> parameter has a value
|
||||
* of <tt>inplace</tt>.
|
||||
*
|
||||
* @throws IOException if an error occured while building the webapp
|
||||
*/
|
||||
public void generateInPlaceWebapp()
|
||||
throws IOException
|
||||
{
|
||||
webappDirectory = warSourceDirectory;
|
||||
|
||||
generateExplodedWebapp();
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the WarMojo on the current project.
|
||||
*
|
||||
|
|
@ -311,138 +102,27 @@ public class WarMojo
|
|||
* @throws DependencyResolutionRequiredException
|
||||
*/
|
||||
private void performPackaging( File warFile )
|
||||
throws IOException, ArchiverException, ManifestException, DependencyResolutionRequiredException
|
||||
throws IOException, ArchiverException, ManifestException, DependencyResolutionRequiredException,
|
||||
MojoExecutionException
|
||||
{
|
||||
if ( "inplace".equals( mode ) )
|
||||
{
|
||||
generateInPlaceWebapp();
|
||||
}
|
||||
else
|
||||
{
|
||||
generateExplodedWebapp();
|
||||
buildExplodedWebapp( getWebappDirectory() );
|
||||
|
||||
// TODO: make a separate 'exploded' Mojo. For now,
|
||||
// disable not making an artifact so the install phase
|
||||
// doesn't fail.
|
||||
if ( !"exploded".equals( mode ) )
|
||||
{
|
||||
//generate war file
|
||||
getLog().info( "Generating war " + warFile.getAbsolutePath() );
|
||||
//generate war file
|
||||
getLog().info( "Generating war " + warFile.getAbsolutePath() );
|
||||
|
||||
MavenArchiver archiver = new MavenArchiver();
|
||||
MavenArchiver archiver = new MavenArchiver();
|
||||
|
||||
archiver.setArchiver( warArchiver );
|
||||
archiver.setArchiver( warArchiver );
|
||||
|
||||
archiver.setOutputFile( warFile );
|
||||
archiver.setOutputFile( warFile );
|
||||
|
||||
warArchiver.addDirectory( webappDirectory, getIncludes(), getExcludes() );
|
||||
warArchiver.addDirectory( getWebappDirectory(), getIncludes(), getExcludes() );
|
||||
|
||||
warArchiver.setWebxml( new File( webappDirectory, "WEB-INF/web.xml" ) );
|
||||
warArchiver.setWebxml( new File( getWebappDirectory(), "WEB-INF/web.xml" ) );
|
||||
|
||||
// create archive
|
||||
archiver.createArchive( project, archive );
|
||||
// create archive
|
||||
archiver.createArchive( getProject(), archive );
|
||||
|
||||
project.getArtifact().setFile( warFile );
|
||||
}
|
||||
else
|
||||
{
|
||||
getLog().warn( "Exploded mode will be deprecated in the next release. It is not compatible with install/deploy goals" );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the default exclude tokens.
|
||||
*
|
||||
* @return a list of <code>String</code> tokens
|
||||
* @todo copied again. Next person to touch it puts it in the right place! :)
|
||||
*/
|
||||
public List getDefaultExcludes()
|
||||
{
|
||||
List defaultExcludes = new ArrayList();
|
||||
defaultExcludes.add( "**/*~" );
|
||||
defaultExcludes.add( "**/#*#" );
|
||||
defaultExcludes.add( "**/.#*" );
|
||||
defaultExcludes.add( "**/%*%" );
|
||||
defaultExcludes.add( "**/._*" );
|
||||
|
||||
// CVS
|
||||
defaultExcludes.add( "**/CVS" );
|
||||
defaultExcludes.add( "**/CVS/**" );
|
||||
defaultExcludes.add( "**/.cvsignore" );
|
||||
|
||||
// SCCS
|
||||
defaultExcludes.add( "**/SCCS" );
|
||||
defaultExcludes.add( "**/SCCS/**" );
|
||||
|
||||
// Visual SourceSafe
|
||||
defaultExcludes.add( "**/vssver.scc" );
|
||||
|
||||
// Subversion
|
||||
defaultExcludes.add( "**/.svn" );
|
||||
defaultExcludes.add( "**/.svn/**" );
|
||||
|
||||
// Mac
|
||||
defaultExcludes.add( "**/.DS_Store" );
|
||||
|
||||
// Windows Thumbs
|
||||
defaultExcludes.add( "**/Thumbs.db" );
|
||||
|
||||
return defaultExcludes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of filenames that should be copied
|
||||
* over to the destination directory.
|
||||
*
|
||||
* @param sourceDir the directory to be scanned
|
||||
* @return the array of filenames, relative to the sourceDir
|
||||
*/
|
||||
private String[] getWarFiles( File sourceDir )
|
||||
{
|
||||
DirectoryScanner scanner = new DirectoryScanner();
|
||||
scanner.setBasedir( sourceDir );
|
||||
scanner.setExcludes( getExcludes() );
|
||||
scanner.addDefaultExcludes();
|
||||
|
||||
scanner.setIncludes( getIncludes() );
|
||||
|
||||
scanner.scan();
|
||||
|
||||
return scanner.getIncludedFiles();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string array of the excludes to be used
|
||||
* when assembling/copying the war.
|
||||
*
|
||||
* @return an array of tokens to exclude
|
||||
*/
|
||||
private String[] getExcludes()
|
||||
{
|
||||
List excludeList = getDefaultExcludes();
|
||||
if ( warSourceExcludes != null && !"".equals( warSourceExcludes ) )
|
||||
{
|
||||
excludeList.add( warSourceExcludes );
|
||||
}
|
||||
|
||||
// if webXML is specified, omit the one in the source directory
|
||||
if ( webXml != null && !"".equals( webXml ) )
|
||||
{
|
||||
excludeList.add( "**/" + WEB_INF + "/web.xml" );
|
||||
}
|
||||
|
||||
return (String[]) excludeList.toArray( EMPTY_STRING_ARRAY );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string array of the includes to be used
|
||||
* when assembling/copying the war.
|
||||
*
|
||||
* @return an array of tokens to include
|
||||
*/
|
||||
private String[] getIncludes()
|
||||
{
|
||||
return new String[]{warSourceIncludes};
|
||||
getProject().getArtifact().setFile( warFile );
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue