1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/entity/BasicHttpEntity.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 496070 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-01-14 04:18:34 -0800 (Sun, 14 Jan 2007) $ 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.entity; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.IOException; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.InputStream; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.OutputStream; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A generic streamed entity being received on a connection. 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 496070 $ 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 46d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 47d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 48d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 49d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 51d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class BasicHttpEntity extends AbstractHttpEntity { 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private InputStream content; 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private boolean contentObtained; 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private long length; 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Creates a new basic entity. 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The content is initially missing, the content length 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * is set to a negative number. 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public BasicHttpEntity() { 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.length = -1; 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public long getContentLength() { 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.length; 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the content, once only. 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the content, if this is the first call to this method 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * since {@link #setContent setContent} has been called 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IllegalStateException 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if the content has been obtained before, or 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * has not yet been provided 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public InputStream getContent() 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IllegalStateException { 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.content == null) { 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalStateException("Content has not been provided"); 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.contentObtained) { 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalStateException("Content has been consumed"); 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.contentObtained = true; 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return this.content; 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } // getContent 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Tells that this entity is not repeatable. 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return <code>false</code> 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isRepeatable() { 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Specifies the length of the content. 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param len the number of bytes in the content, or 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * a negative number to indicate an unknown length 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void setContentLength(long len) { 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.length = len; 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Specifies the content. 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param instream the stream to return with the next call to 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link #getContent getContent} 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void setContent(final InputStream instream) { 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.content = instream; 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.contentObtained = false; 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void writeTo(final OutputStream outstream) throws IOException { 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (outstream == null) { 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Output stream may not be null"); 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project InputStream instream = getContent(); 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int l; 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project byte[] tmp = new byte[2048]; 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while ((l = instream.read(tmp)) != -1) { 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project outstream.write(tmp, 0, l); 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean isStreaming() { 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return !this.contentObtained && this.content != null; 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // non-javadoc, see interface HttpEntity 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void consumeContent() throws IOException { 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (content != null) { 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project content.close(); // reads to the end of the entity 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // class BasicHttpEntity 152