View Javadoc
1   package org.codehaus.mojo.wagon.shared;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.IOException;
23  
24  import org.apache.maven.plugin.logging.Log;
25  import org.apache.maven.wagon.Wagon;
26  import org.apache.maven.wagon.WagonException;
27  
28  /**
29   *
30   */
31  public interface WagonCopy
32  {
33  
34      /**
35       * Transfer files between 2 Wagon URLs. If download directory is not given in the fileset a temporary one will be
36       * created.
37       * 
38       * @param fromWagon - source Wagon
39       * @param fileset - file set to copy
40       * @param toWagon - target Wagon
41       * @param optimize - locally compressed and remotely uncompress for scp only
42       * @param logger - logger used
43       * @throws WagonException if any wagon error
44       * @throws IOException if any io error
45       */
46      void copy( Wagon fromWagon, WagonFileSet fileset, Wagon toWagon, boolean optimize, Log logger )
47          throws WagonException, IOException;
48  
49  }