View Javadoc

1   package org.apache.maven.index.updater;
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.io.FileNotFoundException;
23  import java.io.IOException;
24  import java.io.InputStream;
25  
26  /**
27   * An interface defining resource downloading contract
28   * 
29   * @author Eugene Kuleshov
30   */
31  public interface ResourceFetcher
32  {
33      /**
34       * Connect and start transfer session
35       */
36      void connect( String id, String url )
37          throws IOException;
38  
39      /**
40       * Disconnect and complete transfer session
41       */
42      void disconnect()
43          throws IOException;
44  
45      /**
46       * Retrieves resource as InputStream
47       * 
48       * @param name a name of resource to retrieve
49       */
50      InputStream retrieve( String name )
51          throws IOException, FileNotFoundException;
52  }