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.shared;
017    
018    import java.io.IOException;
019    
020    import org.apache.maven.plugin.logging.Log;
021    import org.apache.maven.wagon.Wagon;
022    import org.apache.maven.wagon.WagonException;
023    
024    /**
025     *
026     */
027    public interface WagonCopy {
028        String ROLE = WagonCopy.class.getName();
029    
030        /**
031         * Transfer files between 2 Wagon URLs. If download directory is not given in the fileset a temporary one will be
032         * created.
033         *
034         * @param fromWagon
035         *            - source Wagon
036         * @param fileset
037         * @param toWagon
038         *            - target Wagon
039         * @param optimize
040         *            - locally compressed and remotely uncompress for scp only
041         * @param logger
042         * @throws WagonException
043         */
044        void copy(Wagon fromWagon, WagonFileSet fileset, Wagon toWagon, boolean optimize, Log logger)
045                throws WagonException, IOException;
046    
047    }