001    package org.codehaus.mojo.wagon.shared;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
005     * agreements. See the NOTICE file distributed with this work for additional information regarding
006     * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance with the License. You may obtain a
008     * copy of the License at
009     * 
010     * http://www.apache.org/licenses/LICENSE-2.0
011     * 
012     * Unless required by applicable law or agreed to in writing, software distributed under the License
013     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
014     * or implied. See the License for the specific language governing permissions and limitations under
015     * the License.
016     */
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    {
029        String ROLE = WagonCopy.class.getName();
030    
031        /**
032         * Transfer files between 2 Wagon URLs.  If download directory is not given in the fileset
033         * a temporary one will be created.
034         * 
035         * @param fromWagon - source Wagon
036         * @param fileset
037         * @param toWagon - target Wagon
038         * @param optimize - locally compressed and remotely uncompress for scp only
039         * @param logger
040         * @throws WagonException
041         */
042        void copy( Wagon fromWagon, WagonFileSet fileset, Wagon toWagon, boolean optimize, Log logger )
043            throws WagonException, IOException;
044    
045    }