View Javadoc

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