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