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 <code>RestClient</code> 020 * class to send and receive mocked requests using the <code>MockRest</code> interface. 021 */ 022public interface MockHttpRequest { 023 024 /** 025 * Sets the URI of the request. 026 * 027 * @param uri The URI of the request. 028 * @return This object (for method chaining). 029 */ 030 MockHttpRequest uri(String uri); 031 032 /** 033 * Sets the URI of the request. 034 * 035 * @param method The URI of the request. 036 * @return This object (for method chaining). 037 */ 038 MockHttpRequest method(String method); 039 040 /** 041 * Sets a header on the request. 042 * 043 * @param name The header name. 044 * @param value The header value. 045 * @return This object (for method chaining). 046 */ 047 MockHttpRequest header(String name, Object value); 048 049 /** 050 * Sets the body of the request. 051 * 052 * @param body The body of the request. 053 * @return This object (for method chaining). 054 */ 055 MockHttpRequest body(Object body); 056 057 /** 058 * Executes the request and returns the response. 059 * 060 * @return The response for the request. 061 * @throws Exception 062 */ 063 MockHttpResponse execute() throws Exception; 064 065}