001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.mock2;
014
015import java.util.*;
016
017/**
018 * Represent the basic connection for mock HTTP requests.
019 *
020 * <p>
021 * Used as a shim between the server and client APIs that allow the <c>RestClient</c>
022 * class to send and receive mocked requests using the <c>MockRest</c> interface.
023 */
024public interface MockHttpConnection {
025
026   /**
027    * Creates a mocked HTTP request.
028    *
029    * @param method The HTTP request method.
030    * @param path The HTTP request path.
031    * @param headers Optional HTTP request headers.
032    * @param body The HTTP request body.
033    * @return A new mock request.
034    * @throws Exception
035    */
036   MockHttpRequest request(String method, String path, Map<String,Object> headers, Object body) throws Exception;
037}