michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client.methods;
michael@0: 
michael@0: import java.net.URI;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpRequest;
michael@0: 
michael@0: /**
michael@0:  * Extended version of the {@link HttpRequest} interface that provides
michael@0:  * convenience methods to access request properties such as request URI
michael@0:  * and method type.
michael@0:  *
michael@0:  *
michael@0:  * <!-- empty lines to avoid svn diff problems -->
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface HttpUriRequest extends HttpRequest {
michael@0: 
michael@0:     /**
michael@0:      * Returns the HTTP method this request uses, such as <code>GET</code>,
michael@0:      * <code>PUT</code>, <code>POST</code>, or other.
michael@0:      */
michael@0:     String getMethod();
michael@0: 
michael@0:     /**
michael@0:      * Returns the URI this request uses, such as
michael@0:      * <code>http://example.org/path/to/file</code>.
michael@0:      * <br/>
michael@0:      * Note that the URI may be absolute URI (as above) or may be a relative URI.
michael@0:      * <p>
michael@0:      * Implementations are encouraged to return
michael@0:      * the URI that was initially requested.
michael@0:      * </p>
michael@0:      * <p>
michael@0:      * To find the final URI after any redirects have been processed,
michael@0:      * please see the section entitled
michael@0:      * <a href="http://hc.apache.org/httpcomponents-client-ga/tutorial/html/fundamentals.html#d4e205">HTTP execution context</a>
michael@0:      * in the
michael@0:      * <a href="http://hc.apache.org/httpcomponents-client-ga/tutorial/html">HttpClient Tutorial</a>
michael@0:      * </p>
michael@0:      */
michael@0:     URI getURI();
michael@0: 
michael@0:     /**
michael@0:      * Aborts execution of the request.
michael@0:      *
michael@0:      * @throws UnsupportedOperationException if the abort operation
michael@0:      *   is not supported / cannot be implemented.
michael@0:      */
michael@0:     void abort() throws UnsupportedOperationException;
michael@0: 
michael@0:     /**
michael@0:      * Tests if the request execution has been aborted.
michael@0:      *
michael@0:      * @return <code>true</code> if the request execution has been aborted,
michael@0:      *   <code>false</code> otherwise.
michael@0:      */
michael@0:     boolean isAborted();
michael@0: 
michael@0: }