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/impl/io/ContentLengthOutputStream.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 560343 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-07-27 11:18:19 -0700 (Fri, 27 Jul 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.impl.io; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.IOException; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.OutputStream; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.io.SessionOutputBuffer; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A stream wrapper that closes itself after a defined number of bytes. 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 560343 $ 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 47d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 48d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 49d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 50d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 52d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class ContentLengthOutputStream extends OutputStream { 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Wrapped session outbut buffer. 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final SessionOutputBuffer out; 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The maximum number of bytes that can be written the stream. Subsequent 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * write operations will be ignored. 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final long contentLength; 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** Total bytes written */ 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private long total = 0; 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** True if the stream is closed. */ 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private boolean closed = false; 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Creates a new length limited stream 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param out The data transmitter to wrap 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param contentLength The maximum number of bytes that can be written to 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the stream. Subsequent write operations will be ignored. 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public ContentLengthOutputStream(final SessionOutputBuffer out, long contentLength) { 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (out == null) { 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Session output buffer may not be null"); 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (contentLength < 0) { 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Content length may not be negative"); 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.out = out; 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.contentLength = contentLength; 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p>Does not close the underlying socket output.</p> 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IOException If an I/O problem occurs. 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void close() throws IOException { 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (!this.closed) { 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.closed = true; 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.out.flush(); 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void flush() throws IOException { 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.out.flush(); 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void write(byte[] b, int off, int len) throws IOException { 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.closed) { 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IOException("Attempted write to closed stream."); 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.total < this.contentLength) { 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project long max = this.contentLength - this.total; 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (len > max) { 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project len = (int) max; 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.out.write(b, off, len); 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.total += len; 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void write(byte[] b) throws IOException { 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project write(b, 0, b.length); 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void write(int b) throws IOException { 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.closed) { 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IOException("Attempted write to closed stream."); 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.total < this.contentLength) { 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.out.write(b); 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.total++; 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 138