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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wagon-maven-plugin Show documentation

Maven plugin that can be used to access various operations on a given URL using a supported maven wagon. Supports recursive upload, download, and list directory content functionality.

There is a newer version: 2.0.2

Show newest version

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.wagon.Wagon;
import org.apache.maven.wagon.WagonException;
import org.codehaus.mojo.wagon.shared.WagonFileSet;

/**
 * Transfers a set of files from a remote URL to a specified local directory.
 * 
 * @goal download
 * @requiresProject false
 */
public class DownloadMojo
    extends AbstractWagonListMojo
{

    /**
     * Local directory to download the remote resource ( tree ) to.
     * 
     * @parameter property="wagon.toDir" default-value="${project.build.directory}/wagon-plugin"
     */
    private File toDir;

    protected void execute( Wagon wagon )
        throws WagonException
    {
        WagonFileSet fileSet = this.getWagonFileSet();
        fileSet.setDownloadDirectory( this.toDir );

        this.wagonDownload.download( wagon, fileSet, this.getLog() );
    }

}