org.codehaus.mojo.wagon.shared.WagonDownload Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wagon-maven-plugin Show documentation

Maven plugin that can be used to access various operations on a given URL using a supported maven wagon. Supports recursive upload, download, and list directory content functionality.

The newest version!

package org.codehaus.mojo.wagon.shared;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.List;

import org.apache.maven.plugin.logging.Log;
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.WagonException;

/**
 *
 */
public interface WagonDownload
{

    /**
     * @param wagon - a Wagon instance
     * @param fileSet - Criteria to build the list
     * @param logger - logger used
     * @return a list of files at the remote host relative to RemoteFileSet's directory
     * @throws WagonException if any wagon error
     */
    List getFileList( Wagon wagon, WagonFileSet fileSet, Log logger )
        throws WagonException;

    /**
     * @param wagon - a Wagon instance
     * @param remoteFileSet - Criteria to build the list
     * @param logger - logger used
     * @throws WagonException if any wagon error
     */
    void download( Wagon wagon, WagonFileSet remoteFileSet, Log logger )
        throws WagonException;

    /**
     * @param wagon - a Wagon instance
     * @param resource - resource to test
     * @throws WagonException if any wagon error
     * @return {@code true} if found, {@code false} otherwise
     */
    boolean exists( Wagon wagon, String resource )
        throws WagonException;

}