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