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 * @deprecated Use <c>org.apache.juneau.rest.mock2</c> 023 */ 024@Deprecated 025public interface MockHttpRequest { 026 027 /** 028 * Sets the URI of the request. 029 * 030 * @param uri The URI of the request. 031 * @return This object (for method chaining). 032 */ 033 MockHttpRequest uri(String uri); 034 035 /** 036 * Sets the URI of the request. 037 * 038 * @param method The URI of the request. 039 * @return This object (for method chaining). 040 */ 041 MockHttpRequest method(String method); 042 043 /** 044 * Sets a header on the request. 045 * 046 * @param name The header name. 047 * @param value The header value. 048 * @return This object (for method chaining). 049 */ 050 MockHttpRequest header(String name, Object value); 051 052 /** 053 * Sets the body of the request. 054 * 055 * @param body The body of the request. 056 * @return This object (for method chaining). 057 */ 058 MockHttpRequest body(Object body); 059 060 /** 061 * Executes the request and returns the response. 062 * 063 * @return The response for the request. 064 * @throws Exception 065 */ 066 MockHttpResponse execute() throws Exception; 067 068}