com.google.code.play.PlayWarMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-maven-plugin Show documentation
Maven Plugin for Play! Framework for integration of these two very different worlds
There is a newer version: 1.0.0-beta8
/*
 * Copyright 2010-2014 Grzegorz Slowikowski
 *
 * 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 com.google.code.play;

import java.io.File;
import java.io.IOException;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProjectHelper;
import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException;

import org.codehaus.plexus.archiver.ArchiverException;
import org.codehaus.plexus.archiver.manager.NoSuchArchiverException;
import org.codehaus.plexus.archiver.war.WarArchiver;

/**
 * Package Play! application as a war achive.
 * 
 * @author Grzegorz Slowikowski
 * @since 1.0.0
 */
@Mojo( name = "war", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.TEST )
public class PlayWarMojo
    extends AbstractPlayWarMojo
{

    /**
     * Skip War generation.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warSkip", defaultValue = "false" )
    private boolean warSkip;

    /**
     * The directory for the generated WAR file.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warOutputDirectory", defaultValue = "${project.build.directory}", required = true )
    private String warOutputDirectory;

    /**
     * The name of the generated WAR file.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warArchiveName", defaultValue = "${project.build.finalName}", required = true )
    private String warArchiveName;

    /**
     * Classifier to add to the generated WAR file.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warClassifier", defaultValue = "" )
    private String warClassifier;

    /**
     * Attach generated WAR file to project artifacts.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warAttach", defaultValue = "false" )
    private boolean warAttach;

    /**
     * WAR webapp directory include filter.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warWebappIncludes", defaultValue = "**" )
    private String warWebappIncludes;

    /**
     * WAR webapp directory exclude filter.
     * "WEB-INF/web.xml" must be included here if this file is present
     * in "warWebappDirectory" directory, because it is processed separately
     * from other "warWebappDirectory" directory content.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.warWebappExcludes", defaultValue = "WEB-INF/web.xml" )
    private String warWebappExcludes;

    /**
     * Maven ProjectHelper.
     * 
     */
    @Component
    private MavenProjectHelper projectHelper;

    protected void internalExecute()
        throws MojoExecutionException, MojoFailureException, IOException
    {
        if ( warSkip )
        {
            getLog().info( "War generation skipped" );
            return;
        }

        String checkMessage = playModuleNotApplicationCheck();
        if ( checkMessage != null )
        {
            getLog().info( checkMessage );
            return;
        }

        checkIfPrecompiled();

        try
        {
            File destFile = new File( warOutputDirectory, getDestinationFileName() );

            ConfigurationParser configParser = getConfiguration();

            WarArchiver warArchiver = prepareArchiver( configParser, true );
            warArchiver.setDestFile( destFile );

            warArchiver.createArchive();
            
            if ( warAttach )
            {
                projectHelper.attachArtifact( project, "war", warClassifier, destFile );
            }
        }
        catch ( ArchiverException e )
        {
            throw new MojoExecutionException( "?", e );
        }
        catch ( DependencyTreeBuilderException e )
        {
            throw new MojoExecutionException( "?", e );
        }
        catch ( NoSuchArchiverException e )
        {
            throw new MojoExecutionException( "?", e );
        }
    }

    private String getDestinationFileName()
    {
        StringBuffer buf = new StringBuffer();
        buf.append( warArchiveName );
        if ( warClassifier != null && !"".equals( warClassifier ) )
        {
            if ( !warClassifier.startsWith( "-" ) )
            {
                buf.append( '-' );
            }
            buf.append( warClassifier );
        }
        buf.append( ".war" );
        return buf.toString();
    }

    protected String getWebappIncludes()
    {
        return warWebappIncludes;
    }

    protected String getWebappExcludes()
    {
        return warWebappExcludes;
    }

}