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