/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.search.api.transport;

import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;

/**
 * A trivial "transport abstraction" to make possible pluggable implementations. Most obviously leans toward HTTP,
 * but is not limited to.
 *
 * @since TBD
 */
public interface Transport {
    /**
     * Trivial response.
     */
    interface Response extends Closeable {
        int getCode();

        Map<String, String> getHeaders();

        InputStream getBody();
    }

    /**
     * This method should issue HTTP GET requests using {@code serviceUri} and return response.
     */
    Response get(String serviceUri, Map<String, String> headers) throws IOException;

    /**
     * This method should issue HTTP HEAD requests using {@code serviceUri} and return response.
     */
    Response head(String serviceUri, Map<String, String> headers) throws IOException;
}
