View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a 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,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.index.updater;
20  
21  import java.io.FileNotFoundException;
22  import java.io.IOException;
23  import java.io.InputStream;
24  
25  /**
26   * An interface defining resource downloading contract
27   *
28   * @author Eugene Kuleshov
29   */
30  public interface ResourceFetcher {
31      /**
32       * Connect and start transfer session
33       */
34      void connect(String id, String url) throws IOException;
35  
36      /**
37       * Disconnect and complete transfer session
38       */
39      void disconnect() throws IOException;
40  
41      /**
42       * Retrieves resource as InputStream
43       *
44       * @param name a name of resource to retrieve
45       */
46      InputStream retrieve(String name) throws IOException, FileNotFoundException;
47  }