1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.client5.http.classic.methods;
29
30 import org.apache.hc.client5.http.config.Configurable;
31 import org.apache.hc.core5.http.ClassicHttpRequest;
32
33 /**
34 * Extended version of the {@link ClassicHttpRequest} interface that provides
35 * convenience methods to access request properties such as request URI
36 * and method type.
37 *
38 * @since 4.0
39 */
40 public interface HttpUriRequest extends ClassicHttpRequest, Configurable {
41
42 /**
43 * Aborts execution of the request.
44 *
45 * @throws UnsupportedOperationException if the abort operation
46 * is not supported / cannot be implemented.
47 */
48 void abort() throws UnsupportedOperationException;
49
50 /**
51 * Tests if the request execution has been aborted.
52 *
53 * @return {@code true} if the request execution has been aborted,
54 * {@code false} otherwise.
55 */
56 boolean isAborted();
57
58 }