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.util.List;
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 WagonDownload
32 {
33
34 /**
35 * @param wagon - a Wagon instance
36 * @param fileSet - Criteria to build the list
37 * @param logger - logger used
38 * @return a list of files at the remote host relative to RemoteFileSet's directory
39 * @throws WagonException if any wagon error
40 */
41 List getFileList( Wagon wagon, WagonFileSet fileSet, Log logger )
42 throws WagonException;
43
44 /**
45 * @param wagon - a Wagon instance
46 * @param remoteFileSet - Criteria to build the list
47 * @param logger - logger used
48 * @throws WagonException if any wagon error
49 */
50 void download( Wagon wagon, WagonFileSet remoteFileSet, Log logger )
51 throws WagonException;
52
53 /**
54 * @param wagon - a Wagon instance
55 * @param resource - resource to test
56 * @throws WagonException if any wagon error
57 * @return {@code true} if found, {@code false} otherwise
58 */
59 boolean exists( Wagon wagon, String resource )
60 throws WagonException;
61
62 }