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
015import java.util.*;
016
017/**
018 * Represent the basic interface for an HTTP response.
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 *
024 * <div class='warn'>
025 *    <b>Deprecated</b> - Use <c>org.apache.juneau.rest.mock2</c>
026 * </div>
027 */
028@Deprecated
029public interface MockHttpResponse {
030
031   /**
032    * Returns the status code of the response.
033    *
034    * @return The status code of the response.
035    */
036   int getStatus();
037
038   /**
039    * Returns the status message of the response.
040    *
041    * @return The status message of the response.
042    */
043   String getMessage();
044
045   /**
046    * Returns the headers of the response.
047    *
048    * @return The headers of the response.
049    */
050   Map<String,String[]> getHeaders();
051
052   /**
053    * Returns the body of the response.
054    *
055    * @return The body of the response.
056    */
057   byte[] getBody();
058}