1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/methods/HttpRequestBase.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 674186 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-07-05 05:18:54 -0700 (Sat, 05 Jul 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.client.methods; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.IOException; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.net.URI; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.concurrent.locks.Lock; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.concurrent.locks.ReentrantLock; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.ProtocolVersion; 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.RequestLine; 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.client.utils.CloneUtils; 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.conn.ClientConnectionRequest; 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.conn.ConnectionReleaseTrigger; 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.message.AbstractHttpMessage; 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.message.BasicRequestLine; 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.message.HeaderGroup; 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.params.HttpParams; 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.params.HttpProtocolParams; 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Basic implementation of an HTTP request that can be modified. 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 674186 $ 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic abstract class HttpRequestBase extends AbstractHttpMessage 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project implements HttpUriRequest, AbortableHttpRequest, Cloneable { 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private Lock abortLock; 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private boolean aborted; 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private URI uri; 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private ClientConnectionRequest connRequest; 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private ConnectionReleaseTrigger releaseTrigger; 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public HttpRequestBase() { 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock = new ReentrantLock(); 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public abstract String getMethod(); 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public ProtocolVersion getProtocolVersion() { 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return HttpProtocolParams.getVersion(getParams()); 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public URI getURI() { 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.uri; 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public RequestLine getRequestLine() { 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String method = getMethod(); 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ProtocolVersion ver = getProtocolVersion(); 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project URI uri = getURI(); 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String uritext = null; 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (uri != null) { 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project uritext = uri.toASCIIString(); 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (uritext == null || uritext.length() == 0) { 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project uritext = "/"; 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new BasicRequestLine(method, uritext, ver); 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void setURI(final URI uri) { 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.uri = uri; 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void setConnectionRequest(final ClientConnectionRequest connRequest) 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock.lock(); 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.aborted) { 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IOException("Request already aborted"); 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.releaseTrigger = null; 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.connRequest = connRequest; 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock.unlock(); 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void setReleaseTrigger(final ConnectionReleaseTrigger releaseTrigger) 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock.lock(); 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.aborted) { 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IOException("Request already aborted"); 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.connRequest = null; 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.releaseTrigger = releaseTrigger; 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock.unlock(); 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void abort() { 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ClientConnectionRequest localRequest; 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ConnectionReleaseTrigger localTrigger; 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock.lock(); 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.aborted) { 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return; 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.aborted = true; 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project localRequest = connRequest; 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project localTrigger = releaseTrigger; 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.abortLock.unlock(); 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // Trigger the callbacks outside of the lock, to prevent 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // deadlocks in the scenario where the callbacks have 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // their own locks that may be used while calling 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // setReleaseTrigger or setConnectionRequest. 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (localRequest != null) { 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project localRequest.abortRequest(); 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (localTrigger != null) { 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project localTrigger.abortConnection(); 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (IOException ex) { 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // ignore 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isAborted() { 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.aborted; 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public Object clone() throws CloneNotSupportedException { 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HttpRequestBase clone = (HttpRequestBase) super.clone(); 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project clone.abortLock = new ReentrantLock(); 174069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project clone.aborted = false; 175069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project clone.releaseTrigger = null; 176069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project clone.connRequest = null; 177069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project clone.headergroup = (HeaderGroup) CloneUtils.clone(this.headergroup); 178069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project clone.params = (HttpParams) CloneUtils.clone(this.params); 179069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return clone; 180069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 181069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 182069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 183