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/conn/BasicManagedEntity.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-06-27 12:49:20 -0700 (Fri, 27 Jun 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this work for additional information regarding copyright ownership. 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * (the "License"); you may not use this file except in compliance with 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 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, software 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.conn; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.IOException; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.InputStream; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.OutputStream; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpEntity; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.entity.HttpEntityWrapper; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * An entity that releases a {@link ManagedClientConnection connection}. 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A {@link ManagedClientConnection} will 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * typically <i>not</i> return a managed entity, but you can replace 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the unmanaged entity in the response with a managed one. 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:rolandw at apache.org">Roland Weber</a> 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <!-- empty lines to avoid svn diff problems --> 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 672367 $ 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 54d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 55d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 56d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 57d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 59d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class BasicManagedEntity extends HttpEntityWrapper 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project implements ConnectionReleaseTrigger, EofSensorWatcher { 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** The connection to release. */ 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected ManagedClientConnection managedConn; 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** Whether to keep the connection alive. */ 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected final boolean attemptReuse; 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Creates a new managed entity that can release a connection. 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param entity the entity of which to wrap the content. 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Note that the argument entity can no longer be used 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * afterwards, since the content will be taken by this 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * managed entity. 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param conn the connection to release 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param reuse whether the connection should be re-used 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public BasicManagedEntity(HttpEntity entity, 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ManagedClientConnection conn, 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean reuse) { 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(entity); 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (conn == null) 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ("Connection may not be null."); 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.managedConn = conn; 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.attemptReuse = reuse; 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isRepeatable() { 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public InputStream getContent() throws IOException { 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new EofSensorInputStream(wrappedEntity.getContent(), this); 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void consumeContent() throws IOException { 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (managedConn == null) 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return; 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (attemptReuse) { 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // this will not trigger a callback from EofSensorInputStream 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project wrappedEntity.consumeContent(); 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn.markReusable(); 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project releaseManagedConnection(); 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void writeTo(final OutputStream outstream) throws IOException { 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super.writeTo(outstream); 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project consumeContent(); 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface ConnectionReleaseTrigger 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void releaseConnection() 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.consumeContent(); 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface ConnectionReleaseTrigger 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void abortConnection() 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (managedConn != null) { 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn.abortConnection(); 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn = null; 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface EofSensorWatcher 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean eofDetected(InputStream wrapped) 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (attemptReuse && (managedConn != null)) { 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // there may be some cleanup required, such as 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // reading trailers after the response body: 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project wrapped.close(); 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn.markReusable(); 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project releaseManagedConnection(); 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 174069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 175069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 176069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface EofSensorWatcher 177069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean streamClosed(InputStream wrapped) 178069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 179069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 180069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 181069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (attemptReuse && (managedConn != null)) { 182069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // this assumes that closing the stream will 183069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // consume the remainder of the response body: 184069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project wrapped.close(); 185069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn.markReusable(); 186069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 187069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 188069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project releaseManagedConnection(); 189069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 190069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 191069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 192069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 193069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 194069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface EofSensorWatcher 195069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean streamAbort(InputStream wrapped) 196069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 197069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 198069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (managedConn != null) { 199069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn.abortConnection(); 200069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 201069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 202069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 203069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 204069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 205069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 206069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Releases the connection gracefully. 207069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The connection attribute will be nullified. 208069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Subsequent invocations are no-ops. 209069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 210069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IOException in case of an IO problem. 211069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The connection attribute will be nullified anyway. 212069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 213069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected void releaseManagedConnection() 214069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException { 215069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 216069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (managedConn != null) { 217069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 218069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn.releaseConnection(); 219069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } finally { 220069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project managedConn = null; 221069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 222069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 223069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 224069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 225069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // class BasicManagedEntity 226