• file
• revisions
• annotate
• diff
• comparison
• raw

mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/io/ContentLengthOutputStream.java@b8a032363ba2 (annotated)

mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/io/ContentLengthOutputStream.java

Thu, 22 Jan 2015 13:21:57 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Thu, 22 Jan 2015 13:21:57 +0100

branch

TOR_BUG_9701

changeset 15

b8a032363ba2

permissions

-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0	1	/*
michael@0	2	* ====================================================================
michael@0	3	* Licensed to the Apache Software Foundation (ASF) under one
michael@0	4	* or more contributor license agreements. See the NOTICE file
michael@0	5	* distributed with this work for additional information
michael@0	6	* regarding copyright ownership. The ASF licenses this file
michael@0	7	* to you under the Apache License, Version 2.0 (the
michael@0	8	* "License"); you may not use this file except in compliance
michael@0	9	* with the License. You may obtain a copy of the License at
michael@0	10	*
michael@0	11	* http://www.apache.org/licenses/LICENSE-2.0
michael@0	12	*
michael@0	13	* Unless required by applicable law or agreed to in writing,
michael@0	14	* software distributed under the License is distributed on an
michael@0	15	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0	16	* KIND, either express or implied. See the License for the
michael@0	17	* specific language governing permissions and limitations
michael@0	18	* under the License.
michael@0	19	* ====================================================================
michael@0	20	*
michael@0	21	* This software consists of voluntary contributions made by many
michael@0	22	* individuals on behalf of the Apache Software Foundation. For more
michael@0	23	* information on the Apache Software Foundation, please see
michael@0	24	* <http://www.apache.org/>.
michael@0	25	*
michael@0	26	*/
michael@0	27
michael@0	28	package ch.boye.httpclientandroidlib.impl.io;
michael@0	29
michael@0	30	import java.io.IOException;
michael@0	31	import java.io.OutputStream;
michael@0	32
michael@0	33	import ch.boye.httpclientandroidlib.io.SessionOutputBuffer;
michael@0	34
michael@0	35	/**
michael@0	36	* Output stream that cuts off after a defined number of bytes. This class
michael@0	37	* is used to send content of HTTP messages where the end of the content entity
michael@0	38	* is determined by the value of the <code>Content-Length header</code>.
michael@0	39	* Entities transferred using this stream can be maximum {@link Long#MAX_VALUE}
michael@0	40	* long.
michael@0	41	* <p>
michael@0	42	* Note that this class NEVER closes the underlying stream, even when close
michael@0	43	* gets called. Instead, the stream will be marked as closed and no further
michael@0	44	* output will be permitted.
michael@0	45	*
michael@0	46	* @since 4.0
michael@0	47	*/
michael@0	48	public class ContentLengthOutputStream extends OutputStream {
michael@0	49
michael@0	50	/**
michael@0	51	* Wrapped session output buffer.
michael@0	52	*/
michael@0	53	private final SessionOutputBuffer out;
michael@0	54
michael@0	55	/**
michael@0	56	* The maximum number of bytes that can be written the stream. Subsequent
michael@0	57	* write operations will be ignored.
michael@0	58	*/
michael@0	59	private final long contentLength;
michael@0	60
michael@0	61	/** Total bytes written */
michael@0	62	private long total = 0;
michael@0	63
michael@0	64	/** True if the stream is closed. */
michael@0	65	private boolean closed = false;
michael@0	66
michael@0	67	/**
michael@0	68	* Wraps a session output buffer and cuts off output after a defined number
michael@0	69	* of bytes.
michael@0	70	*
michael@0	71	* @param out The session output buffer
michael@0	72	* @param contentLength The maximum number of bytes that can be written to
michael@0	73	* the stream. Subsequent write operations will be ignored.
michael@0	74	*
michael@0	75	* @since 4.0
michael@0	76	*/
michael@0	77	public ContentLengthOutputStream(final SessionOutputBuffer out, long contentLength) {
michael@0	78	super();
michael@0	79	if (out == null) {
michael@0	80	throw new IllegalArgumentException("Session output buffer may not be null");
michael@0	81	}
michael@0	82	if (contentLength < 0) {
michael@0	83	throw new IllegalArgumentException("Content length may not be negative");
michael@0	84	}
michael@0	85	this.out = out;
michael@0	86	this.contentLength = contentLength;
michael@0	87	}
michael@0	88
michael@0	89	/**
michael@0	90	* <p>Does not close the underlying socket output.</p>
michael@0	91	*
michael@0	92	* @throws IOException If an I/O problem occurs.
michael@0	93	*/
michael@0	94	public void close() throws IOException {
michael@0	95	if (!this.closed) {
michael@0	96	this.closed = true;
michael@0	97	this.out.flush();
michael@0	98	}
michael@0	99	}
michael@0	100
michael@0	101	public void flush() throws IOException {
michael@0	102	this.out.flush();
michael@0	103	}
michael@0	104
michael@0	105	public void write(byte[] b, int off, int len) throws IOException {
michael@0	106	if (this.closed) {
michael@0	107	throw new IOException("Attempted write to closed stream.");
michael@0	108	}
michael@0	109	if (this.total < this.contentLength) {
michael@0	110	long max = this.contentLength - this.total;
michael@0	111	if (len > max) {
michael@0	112	len = (int) max;
michael@0	113	}
michael@0	114	this.out.write(b, off, len);
michael@0	115	this.total += len;
michael@0	116	}
michael@0	117	}
michael@0	118
michael@0	119	public void write(byte[] b) throws IOException {
michael@0	120	write(b, 0, b.length);
michael@0	121	}
michael@0	122
michael@0	123	public void write(int b) throws IOException {
michael@0	124	if (this.closed) {
michael@0	125	throw new IOException("Attempted write to closed stream.");
michael@0	126	}
michael@0	127	if (this.total < this.contentLength) {
michael@0	128	this.out.write(b);
michael@0	129	this.total++;
michael@0	130	}
michael@0	131	}
michael@0	132
michael@0	133	}