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.search.api.transport;
20
21 import java.io.Closeable;
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.util.Map;
25
26 /**
27 * A trivial "transport abstraction" to make possible pluggable implementations. Most obviously leans toward HTTP,
28 * but is not limited to.
29 *
30 * @since TBD
31 */
32 public interface Transport {
33 /**
34 * Trivial response.
35 */
36 interface Response extends Closeable {
37 int getCode();
38
39 Map<String, String> getHeaders();
40
41 InputStream getBody();
42 }
43
44 /**
45 * This method should issue HTTP GET requests using {@code serviceUri} and return response.
46 */
47 Response get(String serviceUri, Map<String, String> headers) throws IOException;
48
49 /**
50 * This method should issue HTTP HEAD requests using {@code serviceUri} and return response.
51 */
52 Response head(String serviceUri, Map<String, String> headers) throws IOException;
53 }