org.apache.maven.plugin.eclipse.writers.rad.RadLibCopier Maven / Gradle / Ivy

Go to download
package org.apache.maven.plugin.eclipse.writers.rad;

/*
 * 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 java.io.File;
import java.io.IOException;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.eclipse.Constants;
import org.apache.maven.plugin.eclipse.Messages;
import org.apache.maven.plugin.eclipse.writers.AbstractEclipseWriter;
import org.apache.maven.plugin.ide.IdeDependency;
import org.apache.maven.plugin.ide.IdeUtils;
import org.apache.maven.plugin.ide.JeeUtils;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.FileUtils;

/**
 * Copy all dependent jar in the directorys where RAD6 needs then to use the runtime enviorment in RAD6. so all
 * dependent jars in the EAR rootdirectory and all dependend jars in the WAR WEB-INF/lib directory
 * 
 * @author Richard van Nieuwenhoven
 */
public class RadLibCopier
    extends AbstractEclipseWriter
{

    /**
     * copy the jars in the apropreate directorys.
     * 
     * @throws MojoExecutionException when writing the config files was not possible
     */
    public void write()
        throws MojoExecutionException
    {
        IdeDependency[] deps = config.getDeps();

        String packaging = config.getPackaging();
        if ( Constants.PROJECT_PACKAGING_EAR.equals( packaging ) )
        {
            handleEarLibs( deps );
        }
        else if ( Constants.PROJECT_PACKAGING_WAR.equals( packaging ) )
        {
            handleWarLibs( deps );
        }
    }

    /**
     * Copies the Artifact after building the destination file name if overridden. This method also checks if the
     * classifier is set and adds it to the destination file name if needed.
     * 
     * @param deps representing the dependencies to be copied.
     * @param destDir where should the atifact go.
     * @throws MojoExecutionException with a message if an error occurs.
     */
    private void copyArtifact( IdeDependency[] deps, File destDir )
        throws MojoExecutionException
    {
        String[] oldFiles =
            FileUtils.getFilesFromExtension( destDir.getAbsolutePath(),
                                             new String[] { Constants.PROJECT_PACKAGING_JAR } );
        for ( String oldFile : oldFiles )
        {
            if ( !new File( oldFile ).delete() )
            {
                log.error( Messages.getString( "Rad6LibCopier.cantdeletefile", new Object[] { oldFile } ) );
            }
        }
        for ( IdeDependency dep : deps )
        {
            if ( !dep.isTestDependency() && !dep.isProvided() && !dep.isReferencedProject() && !dep.isSystemScoped() )
            {
                copyFile( dep.getFile(), new File( destDir, dep.getFile().getName() ), log );
            }
        }
    }

    /**
     * Does the actual copy of the file and logging.
     * 
     * @param artifact represents the file to copy.
     * @param destFile file name of destination file.
     * @param log to use for output.
     * @throws MojoExecutionException with a message if an error occurs.
     */
    private void copyFile( File artifact, File destFile, Log log )
        throws MojoExecutionException
    {
        try
        {
            log.info( "Copying " + artifact.getAbsolutePath() + " to " + destFile );
            FileUtils.copyFile( artifact, destFile );
        }
        catch ( IOException e )
        {
            throw new MojoExecutionException( "Error copying artifact from " + artifact + " to " + destFile, e );
        }
    }

    /**
     * EARs need the jars in the root directory.
     * 
     * @param deps dependencys to include
     * @throws MojoExecutionException if the copying fails
     */
    private void handleEarLibs( IdeDependency[] deps )
        throws MojoExecutionException
    {
        File targetDir = config.getProject().getBasedir();
        copyArtifact( deps, targetDir );
    }

    /**
     * WARs need the jars in the WEB-INF/lib directory.
     * 
     * @param deps dependencys to include
     * @throws MojoExecutionException if the copying fails
     */
    private void handleWarLibs( IdeDependency[] deps )
        throws MojoExecutionException
    {
        File basedir = config.getProject().getBasedir();

        // Generating web content settings based on war plug-in warSourceDirectory property
        File warSourceDirectory =
            new File( IdeUtils.getPluginSetting( config.getProject(), JeeUtils.ARTIFACT_MAVEN_WAR_PLUGIN,
                                                 "warSourceDirectory", //$NON-NLS-1$
                                                 "src/main/webapp" ) ); //$NON-NLS-1$
        String webContentDir =
            IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(), warSourceDirectory, false );

        String srcMainWebappWebInfLibDirName =
            basedir.getAbsolutePath() + File.separatorChar + webContentDir + File.separatorChar + "WEB-INF"
                + File.separatorChar + "lib";

        File srcMainWebappWebInfLibDir = new File( srcMainWebappWebInfLibDirName );
        srcMainWebappWebInfLibDir.mkdirs();

        copyArtifact( deps, srcMainWebappWebInfLibDir );
    }

}