001    /**
002     * Copyright 2008-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.codehaus.mojo.wagon;
017    
018    /**
019     * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
020     * agreements. See the NOTICE file distributed with this work for additional information regarding
021     * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
022     * "License"); you may not use this file except in compliance with the License. You may obtain a
023     * copy of the License at
024     * 
025     * http://www.apache.org/licenses/LICENSE-2.0
026     * 
027     * Unless required by applicable law or agreed to in writing, software distributed under the License
028     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
029     * or implied. See the License for the specific language governing permissions and limitations under
030     * the License.
031     */
032    
033    import java.io.File;
034    
035    import org.apache.maven.plugin.MojoExecutionException;
036    import org.apache.maven.wagon.Wagon;
037    import org.apache.maven.wagon.WagonException;
038    
039    /**
040     * Download a single file.
041     * 
042     * @goal download-single
043     * @requiresProject false
044     */
045    public class DownloadSingleMojo
046        extends AbstractSingleWagonMojo
047    {
048        /**
049         * Relative path to the URL.
050         * @parameter expression="${wagon.fromFile}"
051         * @required 
052         */
053        private String fromFile;
054        
055        /**
056         * Directory to download the remote file to
057         * @parameter expression="${wagon.toDir}" 
058         */
059        private File toDir;
060    
061        /**
062         * File to download the remote file to.  Use this option to rename the file after download.
063         * When toDir is present, this argument is ignored
064         * @parameter expression="${wagon.toFile}" 
065         */
066        private File toFile;
067        
068    
069        protected void execute( Wagon wagon )
070            throws MojoExecutionException, WagonException
071        {
072            
073            if ( this.skip )
074            {
075                this.getLog().info( "Skip execution." );
076                return;
077            }
078            
079            if ( toDir != null )
080            {
081                toFile = new File( toDir, new File( fromFile ).getName() );
082            }
083            
084            if ( toFile == null )
085            {
086                throw new MojoExecutionException( "Either toDir or toFile is required" );
087            }
088            
089            this.getLog().info( "Downloading: " + wagon.getRepository().getUrl() + "/" + fromFile + " to " + toFile );
090    
091            wagon.get( fromFile, toFile );
092    
093        }
094    
095    }