• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/methods/HttpUriRequest.java $
3  * $Revision: 659191 $
4  * $Date: 2008-05-22 11:26:53 -0700 (Thu, 22 May 2008) $
5  *
6  * ====================================================================
7  * Licensed to the Apache Software Foundation (ASF) under one
8  * or more contributor license agreements.  See the NOTICE file
9  * distributed with this work for additional information
10  * regarding copyright ownership.  The ASF licenses this file
11  * to you under the Apache License, Version 2.0 (the
12  * "License"); you may not use this file except in compliance
13  * with the License.  You may obtain a copy of the License at
14  *
15  *   http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing,
18  * software distributed under the License is distributed on an
19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20  * KIND, either express or implied.  See the License for the
21  * specific language governing permissions and limitations
22  * under the License.
23  * ====================================================================
24  *
25  * This software consists of voluntary contributions made by many
26  * individuals on behalf of the Apache Software Foundation.  For more
27  * information on the Apache Software Foundation, please see
28  * <http://www.apache.org/>.
29  *
30  */
31 
32 package org.apache.http.client.methods;
33 
34 import java.net.URI;
35 
36 import org.apache.http.HttpRequest;
37 
38 /**
39  * Extended version of the {@link HttpRequest} interface that provides
40  * convenience methods to access request properties such as request URI
41  * and method type.
42  *
43  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
44  *
45  * <!-- empty lines to avoid svn diff problems -->
46  * @version   $Revision: 659191 $
47  *
48  * @since 4.0
49  */
50 public interface HttpUriRequest extends HttpRequest {
51 
52     /**
53      * Returns the HTTP method this request uses, such as <code>GET</code>,
54      * <code>PUT</code>, <code>POST</code>, or other.
55      */
getMethod()56     String getMethod();
57 
58     /**
59      * Returns the URI this request uses, such as
60      * <code>http://example.org/path/to/file</code>.
61      */
getURI()62     URI getURI();
63 
64     /**
65      * Aborts execution of the request.
66      *
67      * @throws UnsupportedOperationException if the abort operation
68      *   is not supported / cannot be implemented.
69      */
abort()70     void abort() throws UnsupportedOperationException;
71 
72     /**
73      * Tests if the request execution has been aborted.
74      *
75      * @return <code>true</code> if the request execution has been aborted,
76      *   <code>false</code> otherwise.
77      */
isAborted()78     boolean isAborted();
79 
80 }
81