org.codehaus.mojo.wagon.shared.WagonCopy 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.shared;

import java.io.IOException;

import org.apache.maven.plugin.logging.Log;
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.WagonException;

/**
 *
 */
public interface WagonCopy {
    String ROLE = WagonCopy.class.getName();

    /**
     * Transfer files between 2 Wagon URLs. If download directory is not given in the fileset a temporary one will be
     * created.
     *
     * @param fromWagon
     *            - source Wagon
     * @param fileset
     * @param toWagon
     *            - target Wagon
     * @param optimize
     *            - locally compressed and remotely uncompress for scp only
     * @param logger
     * @throws WagonException
     */
    void copy(Wagon fromWagon, WagonFileSet fileset, Wagon toWagon, boolean optimize, Log logger)
            throws WagonException, IOException;

}