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    /*
019     * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
020     * agreements. See the NOTICE file distributed with this work for additional information regarding
021     * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
022     * "License"); you may not use this file except in compliance with the License. You may obtain a
023     * copy of the License at
024     * 
025     * http://www.apache.org/licenses/LICENSE-2.0
026     * 
027     * Unless required by applicable law or agreed to in writing, software distributed under the License
028     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
029     * or implied. See the License for the specific language governing permissions and limitations under
030     * the License.
031     */
032    
033    import java.io.IOException;
034    
035    import org.apache.maven.plugin.logging.Log;
036    import org.apache.maven.wagon.Wagon;
037    import org.apache.maven.wagon.WagonException;
038    
039    /**
040     * 
041     */
042    public interface WagonCopy
043    {
044        String ROLE = WagonCopy.class.getName();
045    
046        /**
047         * Transfer files between 2 Wagon URLs.  If download directory is not given in the fileset
048         * a temporary one will be created.
049         * 
050         * @param fromWagon - source Wagon
051         * @param fileset
052         * @param toWagon - target Wagon
053         * @param optimize - locally compressed and remotely uncompress for scp only
054         * @param logger
055         * @throws WagonException
056         */
057        void copy( Wagon fromWagon, WagonFileSet fileset, Wagon toWagon, boolean optimize, Log logger )
058            throws WagonException, IOException;
059    
060    }