src/main/java/org/apache/maven/plugin/jar/AbstractJarMojo.java - maven-jar-plugin - Git at Google

 package org.apache.maven.plugin.jar;

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.archiver.MavenArchiveConfiguration;
 import org.apache.maven.archiver.MavenArchiver;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.MavenProjectHelper;
 import org.codehaus.plexus.archiver.Archiver;
 import org.codehaus.plexus.archiver.jar.JarArchiver;

 import java.io.File;

 /**
  * Base class for creating a jar from project classes.
  *
  * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
  * @version $Id$
  */
 public abstract class AbstractJarMojo
     extends AbstractMojo
 {

     private static final String[] DEFAULT_EXCLUDES = new String[]{ "**/package.html" };

     private static final String[] DEFAULT_INCLUDES = new String[]{ "**/**" };

     /**
      * List of files to include. Specified as fileset patterns which are relative to the input directory whose contents
      * is being packaged into the JAR.
      */
     @Parameter
     private String[] includes;

     /**
      * List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents
      * is being packaged into the JAR.
      */
     @Parameter
     private String[] excludes;

     /**
      * Directory containing the generated JAR.
      */
     @Parameter( defaultValue = "${project.build.directory}", required = true )
     private File outputDirectory;

     /**
      * Name of the generated JAR.
      */
     @Parameter( alias = "jarName", property = "jar.finalName", defaultValue = "${project.build.finalName}" )
     private String finalName;

     /**
      * The Jar archiver.
      */
     @Component( role = Archiver.class, hint = "jar" )
     private JarArchiver jarArchiver;

     /**
      * The Maven project.
      */
     @Parameter( defaultValue = "${project}", readonly = true, required = true )
     private MavenProject project;

     /**
      *
      */
     @Parameter( defaultValue = "${session}", readonly = true, required = true )
     private MavenSession session;

     /**
      * The archive configuration to use.
      * See <a href="http://maven.apache.org/shared/maven-archiver/index.html">Maven Archiver Reference</a>.
      */
     @Parameter
     private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();

     /**
      * Path to the default MANIFEST file to use. It will be used if
      * <code>useDefaultManifestFile</code> is set to <code>true</code>.
      *
      * @since 2.2
      */
     @Parameter( defaultValue = "${project.build.outputDirectory}/META-INF/MANIFEST.MF", required = true,
                 readonly = true )
     private File defaultManifestFile;

     /**
      * Set this to <code>true</code> to enable the use of the <code>defaultManifestFile</code>.
      *
      * @since 2.2
      */
     @Parameter( property = "jar.useDefaultManifestFile", defaultValue = "false" )
     private boolean useDefaultManifestFile;

     /**
      *
      */
     @Component
     private MavenProjectHelper projectHelper;

     /**
      * Require the jar plugin to build a new JAR even if none of the contents appear to have changed.
      * By default, this plugin looks to see if the output jar exists and inputs have not changed.
      * If these conditions are true, the plugin skips creation of the jar. This does not work when
      * other plugins, like the maven-shade-plugin, are configured to post-process the jar.
      * This plugin can not detect the post-processing, and so leaves the post-processed jar in place.
      * This can lead to failures when those plugins do not expect to find their own output
      * as an input. Set this parameter to <tt>true</tt> to avoid these problems by forcing
      * this plugin to recreate the jar every time.
      */
     @Parameter( property = "jar.forceCreation", defaultValue = "false" )
     private boolean forceCreation;

     /**
      * Skip creating empty archives
      */
     @Parameter( property = "jar.skipIfEmpty", defaultValue = "false" )
     private boolean skipIfEmpty;

     /**
      * Return the specific output directory to serve as the root for the archive.
      */
     protected abstract File getClassesDirectory();

     protected final MavenProject getProject()
     {
         return project;
     }

     /**
      * Overload this to produce a jar with another classifier, for example a test-jar.
      */
     protected abstract String getClassifier();

     /**
      * Overload this to produce a test-jar, for example.
      */
     protected abstract String getType();

     protected static File getJarFile( File basedir, String finalName, String classifier )
     {
         if ( classifier == null )
         {
             classifier = "";
         }
         else if ( classifier.trim().length() > 0 && !classifier.startsWith( "-" ) )
         {
             classifier = "-" + classifier;
         }

         return new File( basedir, finalName + classifier + ".jar" );
     }

     /**
      * Default Manifest location. Can point to a non existing file.
      * Cannot return null.
      */
     protected File getDefaultManifestFile()
     {
         return defaultManifestFile;
     }


     /**
      * Generates the JAR.
      *
      * @todo Add license files in META-INF directory.
      */
     public File createArchive()
         throws MojoExecutionException
     {
         File jarFile = getJarFile( outputDirectory, finalName, getClassifier() );

         MavenArchiver archiver = new MavenArchiver();

         archiver.setArchiver( jarArchiver );

         archiver.setOutputFile( jarFile );

         archive.setForced( forceCreation );

         try
         {
             File contentDirectory = getClassesDirectory();
             if ( !contentDirectory.exists() )
             {
                 getLog().warn( "JAR will be empty - no content was marked for inclusion!" );
             }
             else
             {
                 archiver.getArchiver().addDirectory( contentDirectory, getIncludes(), getExcludes() );
             }

             File existingManifest = getDefaultManifestFile();

             if ( useDefaultManifestFile && existingManifest.exists() && archive.getManifestFile() == null )
             {
                 getLog().info( "Adding existing MANIFEST to archive. Found under: " + existingManifest.getPath() );
                 archive.setManifestFile( existingManifest );
             }

             archiver.createArchive( session, project, archive );

             return jarFile;
         }
         catch ( Exception e )
         {
             // TODO: improve error handling
             throw new MojoExecutionException( "Error assembling JAR", e );
         }
     }

     /**
      * Generates the JAR.
      *
      * @todo Add license files in META-INF directory.
      */
     public void execute()
         throws MojoExecutionException
     {
         if ( skipIfEmpty && ( !getClassesDirectory().exists() || getClassesDirectory().list().length < 1 ) )
         {
             getLog().info( "Skipping packaging of the " + getType() );
         }
         else
         {
             File jarFile = createArchive();

             String classifier = getClassifier();
             if ( classifier != null )
             {
                 projectHelper.attachArtifact( getProject(), getType(), classifier, jarFile );
             }
             else
             {
                 getProject().getArtifact().setFile( jarFile );
             }
         }
     }

     private String[] getIncludes()
     {
         if ( includes != null && includes.length > 0 )
         {
             return includes;
         }
         return DEFAULT_INCLUDES;
     }

     private String[] getExcludes()
     {
         if ( excludes != null && excludes.length > 0 )
         {
             return excludes;
         }
         return DEFAULT_EXCLUDES;
     }
 }
	package org.apache.maven.plugin.jar;

	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.archiver.MavenArchiveConfiguration;
	import org.apache.maven.archiver.MavenArchiver;
	import org.apache.maven.execution.MavenSession;
	import org.apache.maven.plugin.AbstractMojo;
	import org.apache.maven.plugin.MojoExecutionException;
	import org.apache.maven.plugins.annotations.Component;
	import org.apache.maven.plugins.annotations.Parameter;
	import org.apache.maven.project.MavenProject;
	import org.apache.maven.project.MavenProjectHelper;
	import org.codehaus.plexus.archiver.Archiver;
	import org.codehaus.plexus.archiver.jar.JarArchiver;

	import java.io.File;

	/**
	* Base class for creating a jar from project classes.
	*
	* @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
	* @version $Id$
	*/
	public abstract class AbstractJarMojo
	extends AbstractMojo
	{

	private static final String[] DEFAULT_EXCLUDES = new String[]{ "**/package.html" };

	private static final String[] DEFAULT_INCLUDES = new String[]{ "/" };

	/**
	* List of files to include. Specified as fileset patterns which are relative to the input directory whose contents
	* is being packaged into the JAR.
	*/
	@Parameter
	private String[] includes;

	/**
	* List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents
	* is being packaged into the JAR.
	*/
	@Parameter
	private String[] excludes;

	/**
	* Directory containing the generated JAR.
	*/
	@Parameter( defaultValue = "${project.build.directory}", required = true )
	private File outputDirectory;

	/**
	* Name of the generated JAR.
	*/
	@Parameter( alias = "jarName", property = "jar.finalName", defaultValue = "${project.build.finalName}" )
	private String finalName;

	/**
	* The Jar archiver.
	*/
	@Component( role = Archiver.class, hint = "jar" )
	private JarArchiver jarArchiver;

	/**
	* The Maven project.
	*/
	@Parameter( defaultValue = "${project}", readonly = true, required = true )
	private MavenProject project;

	/**
	*
	*/
	@Parameter( defaultValue = "${session}", readonly = true, required = true )
	private MavenSession session;

	/**
	* The archive configuration to use.
	* See <a href="http://maven.apache.org/shared/maven-archiver/index.html">Maven Archiver Reference</a>.
	*/
	@Parameter
	private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();

	/**
	* Path to the default MANIFEST file to use. It will be used if
	* <code>useDefaultManifestFile</code> is set to <code>true</code>.
	*
	* @since 2.2
	*/
	@Parameter( defaultValue = "${project.build.outputDirectory}/META-INF/MANIFEST.MF", required = true,
	readonly = true )
	private File defaultManifestFile;

	/**
	* Set this to <code>true</code> to enable the use of the <code>defaultManifestFile</code>.
	*
	* @since 2.2
	*/
	@Parameter( property = "jar.useDefaultManifestFile", defaultValue = "false" )
	private boolean useDefaultManifestFile;

	/**
	*
	*/
	@Component
	private MavenProjectHelper projectHelper;

	/**
	* Require the jar plugin to build a new JAR even if none of the contents appear to have changed.
	* By default, this plugin looks to see if the output jar exists and inputs have not changed.
	* If these conditions are true, the plugin skips creation of the jar. This does not work when
	* other plugins, like the maven-shade-plugin, are configured to post-process the jar.
	* This plugin can not detect the post-processing, and so leaves the post-processed jar in place.
	* This can lead to failures when those plugins do not expect to find their own output
	* as an input. Set this parameter to <tt>true</tt> to avoid these problems by forcing
	* this plugin to recreate the jar every time.
	*/
	@Parameter( property = "jar.forceCreation", defaultValue = "false" )
	private boolean forceCreation;

	/**
	* Skip creating empty archives
	*/
	@Parameter( property = "jar.skipIfEmpty", defaultValue = "false" )
	private boolean skipIfEmpty;

	/**
	* Return the specific output directory to serve as the root for the archive.
	*/
	protected abstract File getClassesDirectory();

	protected final MavenProject getProject()
	{
	return project;
	}

	/**
	* Overload this to produce a jar with another classifier, for example a test-jar.
	*/
	protected abstract String getClassifier();

	/**
	* Overload this to produce a test-jar, for example.
	*/
	protected abstract String getType();

	protected static File getJarFile( File basedir, String finalName, String classifier )
	{
	if ( classifier == null )
	{
	classifier = "";
	}
	else if ( classifier.trim().length() > 0 && !classifier.startsWith( "-" ) )
	{
	classifier = "-" + classifier;
	}

	return new File( basedir, finalName + classifier + ".jar" );
	}

	/**
	* Default Manifest location. Can point to a non existing file.
	* Cannot return null.
	*/
	protected File getDefaultManifestFile()
	{
	return defaultManifestFile;
	}


	/**
	* Generates the JAR.
	*
	* @todo Add license files in META-INF directory.
	*/
	public File createArchive()
	throws MojoExecutionException
	{
	File jarFile = getJarFile( outputDirectory, finalName, getClassifier() );

	MavenArchiver archiver = new MavenArchiver();

	archiver.setArchiver( jarArchiver );

	archiver.setOutputFile( jarFile );

	archive.setForced( forceCreation );

	try
	{
	File contentDirectory = getClassesDirectory();
	if ( !contentDirectory.exists() )
	{
	getLog().warn( "JAR will be empty - no content was marked for inclusion!" );
	}
	else
	{
	archiver.getArchiver().addDirectory( contentDirectory, getIncludes(), getExcludes() );
	}

	File existingManifest = getDefaultManifestFile();

	if ( useDefaultManifestFile && existingManifest.exists() && archive.getManifestFile() == null )
	{
	getLog().info( "Adding existing MANIFEST to archive. Found under: " + existingManifest.getPath() );
	archive.setManifestFile( existingManifest );
	}

	archiver.createArchive( session, project, archive );

	return jarFile;
	}
	catch ( Exception e )
	{
	// TODO: improve error handling
	throw new MojoExecutionException( "Error assembling JAR", e );
	}
	}

	/**
	* Generates the JAR.
	*
	* @todo Add license files in META-INF directory.
	*/
	public void execute()
	throws MojoExecutionException
	{
	if ( skipIfEmpty && ( !getClassesDirectory().exists() \|\| getClassesDirectory().list().length < 1 ) )
	{
	getLog().info( "Skipping packaging of the " + getType() );
	}
	else
	{
	File jarFile = createArchive();

	String classifier = getClassifier();
	if ( classifier != null )
	{
	projectHelper.attachArtifact( getProject(), getType(), classifier, jarFile );
	}
	else
	{
	getProject().getArtifact().setFile( jarFile );
	}
	}
	}

	private String[] getIncludes()
	{
	if ( includes != null && includes.length > 0 )
	{
	return includes;
	}
	return DEFAULT_INCLUDES;
	}

	private String[] getExcludes()
	{
	if ( excludes != null && excludes.length > 0 )
	{
	return excludes;
	}
	return DEFAULT_EXCLUDES;
	}
	}