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.utils;
014
015/**
016 * Represent the basic connection for mock HTTP requests.
017 *
018 * <p>
019 * Used as a shim between the server and client APIs that allow the <code>RestClient</code>
020 * class to send and receive mocked requests using the <code>MockRest</code> interface.
021 */
022public interface MockHttpConnection {
023
024   /**
025    * Creates a mocked HTTP request.
026    *
027    * @param method The HTTP request method.
028    * @param path The HTTP request path.
029    * @param body The HTTP request body.
030    * @return A new mock request.
031    * @throws Exception
032    */
033   MockHttpRequest request(String method, String path, Object body) throws Exception;
034}