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.client;
018
019import org.apache.http.*;
020
021/**
022 * Identify an {@link HttpRequest} that was created by a {@link RestRequest}.
023 *
024 * <p>
025 * Allows HTTP client code to get access to the underlying {@link RestRequest} if needed.
026 *
027 * <h5 class='section'>See Also:</h5><ul>
028 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestClientBasics">juneau-rest-client Basics</a>
029 * </ul>
030 */
031public interface RestRequestCreated {
032
033   /**
034    * Returns the {@link RestRequest} object that created the {@link HttpRequest}.
035    *
036    * @return The {@link RestRequest} object that created the {@link HttpRequest}.
037    */
038   RestRequest getRestRequest();
039}