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.backend.smo;
20
21 import java.io.IOException;
22 import java.util.Map;
23
24 /**
25 * A trivial "transport abstraction" to make possible pluggable implementations.
26 */
27 public interface SmoSearchTransport {
28 /**
29 * This method should issue a HTTP GET requests using {@code serviceUri} and return body payload as {@link String}
30 * ONLY if the response was HTTP 200 Ok and there was a payload returned by service. In any other case, it should
31 * throw, never return {@code null}. The payload is expected to be {@code application/json}, so client may add
32 * headers to request. Also, the payload is expected to be "relatively small" that may be enforced.
33 */
34 String fetch(String serviceUri, Map<String, String> headers) throws IOException;
35 }