001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2023 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.client.api;
021
022import java.util.List;
023import java.util.Map;
024
025import org.hl7.fhir.instance.model.api.IBaseBinary;
026
027import ca.uhn.fhir.context.FhirContext;
028import ca.uhn.fhir.rest.api.EncodingEnum;
029
030/**
031 * A HTTP Client interface.
032 */
033public interface IHttpClient {
034
035    /**
036     * Create a byte request
037    * @param theContext TODO
038    * @param theContents the contents
039    * @param theContentType the contentType 
040    * @param theEncoding the encoding
041     * @return the http request to be executed
042     */
043    IHttpRequest createByteRequest(FhirContext theContext, String theContents, String theContentType, EncodingEnum theEncoding);
044
045    /**
046     * Create a parameter request
047    * @param theContext TODO
048    * @param theParams the parameters
049    * @param theEncoding the encoding
050     * @return the http request to be executed
051     */
052    IHttpRequest createParamRequest(FhirContext theContext, Map<String, List<String>> theParams, EncodingEnum theEncoding);
053
054    /**
055     * Create a binary request
056    * @param theContext TODO
057    * @param theBinary the binary
058     * @return the http request to be executed
059     */
060    IHttpRequest createBinaryRequest(FhirContext theContext, IBaseBinary theBinary);
061
062    /**
063     * Create a normal http get request
064    * @param theContext TODO
065    * @param theEncoding the request encoding
066     * @return the http request to be executed
067     */
068    IHttpRequest createGetRequest(FhirContext theContext, EncodingEnum theEncoding);
069
070}