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 interface for an HTTP rquest.
017 *
018 * <p>
019 * Used as a shim between the server and client APIs that allow the <c>RestClient</c>
020 * class to send and receive mocked requests using the <c>MockRest</c> interface.
021 *
022 * <div class='warn'>
023 *    <b>Deprecated</b> - Use <c>org.apache.juneau.rest.mock2</c>
024 * </div>
025 */
026@Deprecated
027public interface MockHttpRequest {
028
029   /**
030    * Sets the URI of the request.
031    *
032    * @param uri The URI of the request.
033    * @return This object (for method chaining).
034    */
035   MockHttpRequest uri(String uri);
036
037   /**
038    * Sets the URI of the request.
039    *
040    * @param method The URI of the request.
041    * @return This object (for method chaining).
042    */
043   MockHttpRequest method(String method);
044
045   /**
046    * Sets a header on the request.
047    *
048    * @param name The header name.
049    * @param value The header value.
050    * @return This object (for method chaining).
051    */
052   MockHttpRequest header(String name, Object value);
053
054   /**
055    * Sets the body of the request.
056    *
057    * @param body The body of the request.
058    * @return This object (for method chaining).
059    */
060   MockHttpRequest body(Object body);
061
062   /**
063    * Executes the request and returns the response.
064    *
065    * @return The response for the request.
066    * @throws Exception
067    */
068   MockHttpResponse execute() throws Exception;
069
070}