org.codehaus.mojo.wagon.DownloadSingleMojo Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2008-2012 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.codehaus.mojo.wagon;

/**
 * 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 org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.WagonException;

/**
 * Download a single file.
 * 
 * @goal download-single
 * @requiresProject false
 */
public class DownloadSingleMojo
    extends AbstractSingleWagonMojo
{
    /**
     * Relative path to the URL.
     * @parameter expression="${wagon.fromFile}"
     * @required 
     */
    private String fromFile;
    
    /**
     * Directory to download the remote file to
     * @parameter expression="${wagon.toDir}" 
     */
    private File toDir;

    /**
     * File to download the remote file to.  Use this option to rename the file after download.
     * When toDir is present, this argument is ignored
     * @parameter expression="${wagon.toFile}" 
     */
    private File toFile;
    

    protected void execute( Wagon wagon )
        throws MojoExecutionException, WagonException
    {
        
        if ( this.skip )
        {
            this.getLog().info( "Skip execution." );
            return;
        }
        
        if ( toDir != null )
        {
            toFile = new File( toDir, new File( fromFile ).getName() );
        }
        
        if ( toFile == null )
        {
            throw new MojoExecutionException( "Either toDir or toFile is required" );
        }
        
        this.getLog().info( "Downloading: " + wagon.getRepository().getUrl() + "/" + fromFile + " to " + toFile );

        wagon.get( fromFile, toFile );

    }

}