PackageMojo.java

/*******************************************************************************
 *
 * Copyright 2011-2014 Spiffy UI Team   
 * 
 * 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.
 *
 ******************************************************************************/

package org.spiffyui.maven.plugins;

import java.io.File;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.archiver.tar.TarArchiver;
import org.codehaus.plexus.archiver.tar.TarArchiver.TarCompressionMethod;

/**
 * Packages spiffy-ui client into an stand-alone archive
 * 
 * @goal package
 * @phase package
 */
public class PackageMojo extends AbstractMojo
{

    /**
     * The maven project.
     * 
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    private MavenProject project;

    /**
     * The directory to archive
     * 
     * @parameter 
     *            default-value="${spiffyui.www}"
     * @required
     */
    private File directory;

    /**
     * Path to emit the package.
     * 
     * @parameter default-value="${project.build.directory}"
     * @required
     */
    private File outputDirectory;

    /**
     * Name of archive
     * 
     * @parameter default-value="${project.build.finalName}.spiffyui-client"
     * @required
     */
    private String archiveName;

    /**
     * Whether creating the archives should be forced.
     * 
     * @parameter expression="${spiffyui.forceCreation}" default-value="false"
     */
    private boolean forceCreation;

    /**
     * The archiver.
     * 
     * @parameter 
     *            expression="${component.org.codehaus.plexus.archiver.Archiver#tar}"
     * @required
     */
    private TarArchiver archiver;
    
    @Override
    public void execute()
        throws MojoExecutionException
    {
        validateDirectory();

        File f = outputDirectory;

        if (!f.exists()) {
            f.mkdirs();
        }

        File archive = new File(f, archiveName);

        try {
            TarCompressionMethod method = new TarCompressionMethod();

            method.setValue("bzip2");

            archiver.setCompression(method);
            archiver.setForced(forceCreation);
            archiver.setDestFile(archive);
            archiver.addDirectory(directory);
            archiver.createArchive();
        } catch (Exception e) {
            throw new MojoExecutionException("Archive creation exception " + e.getMessage());
        }

        project.getArtifact().setFile(archive);
    }

    /**
     * Directory is valid if it exists, does not represent a file, and can be
     * read.
     */
    private void validateDirectory()
        throws MojoExecutionException
    {
        if (directory == null) {
            throw new IllegalArgumentException("Directory should not be null.");
        }
        if (!directory.exists()) {
            throw new MojoExecutionException("Directory does not exist: " + directory);
        }
        if (!directory.isDirectory()) {
            throw new IllegalArgumentException("Is not a directory: " + directory);
        }
        if (!directory.canRead()) {
            throw new IllegalArgumentException("Directory cannot be read: " + directory);
        }
    }

}