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;
018
019import org.apache.http.*;
020import org.apache.juneau.parser.*;
021import org.apache.juneau.rest.client.*;
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/JuneauRestMockBasics">juneau-rest-mock Basics</a>
028 * </ul>
029*/
030@SuppressWarnings("resource")
031public class MockRestResponse extends org.apache.juneau.rest.client.RestResponse {
032
033   /**
034    * Constructor.
035    *
036    * @param client The RestClient that created this response.
037    * @param request The REST request.
038    * @param response The HTTP response.  Can be <jk>null</jk>.
039    * @param parser The overridden parser passed into {@link RestRequest#parser(Parser)}.
040    */
041   public MockRestResponse(RestClient client, RestRequest request, HttpResponse response, Parser parser) {
042      super(client, request, response, parser);
043      ((MockRestClient)client).currentResponse(this);
044   }
045
046   @Override /* Overridden from RestResponse */
047   public MockRestResponse cacheContent() {
048      super.cacheContent();
049      return this;
050   }
051
052   @Override /* Overridden from RestResponse */
053   public MockRestResponse consume() {
054      super.consume();
055      return this;
056   }
057}