001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.mock.classic;
018
019import org.apache.http.*;
020import org.apache.juneau.marshall.parser.*;
021import org.apache.juneau.rest.client.classic.*;
022
023/**
024 * A subclass of {@link RestResponse} with additional features for mocked testing.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestMock">juneau-rest-mock</a>
028 * </ul>
029*/
030@SuppressWarnings({
031   "resource" // MockRestResponse manages Closeable resources
032})
033public class MockRestResponse extends RestResponse {
034
035   /**
036    * Constructor.
037    *
038    * @param client The RestClient that created this response.
039    * @param request The REST request.
040    * @param response The HTTP response.  Can be <jk>null</jk> (a default empty response with a status code of <c>0</c> is substituted).
041    * @param parser The overridden parser passed into {@link RestRequest#parser(Parser)}.
042    */
043   public MockRestResponse(RestClient client, RestRequest request, HttpResponse response, Parser parser) {
044      super(client, request, response, parser);
045      ((MockRestClient)client).currentResponse(this);
046   }
047
048   @Override /* Overridden from RestResponse */
049   public MockRestResponse cacheContent() {
050      super.cacheContent();
051      return this;
052   }
053
054   @Override /* Overridden from RestResponse */
055   public MockRestResponse consume() {
056      super.consume();
057      return this;
058   }
059}