Home | History | Annotate | Download | only in io 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/impl/io/ContentLengthOutputStream.java $
      3  * $Revision: 560343 $
      4  * $Date: 2007-07-27 11:18:19 -0700 (Fri, 27 Jul 2007) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.impl.io;
     33 
     34 import java.io.IOException;
     35 import java.io.OutputStream;
     36 
     37 import org.apache.http.io.SessionOutputBuffer;
     38 
     39 /**
     40  * A stream wrapper that closes itself after a defined number of bytes.
     41  *
     42  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     43  *
     44  * @version $Revision: 560343 $
     45  *
     46  * @since 4.0
     47  *
     48  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     49  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     50  *     for further details.
     51  */
     52 @Deprecated
     53 public class ContentLengthOutputStream extends OutputStream {
     54 
     55     /**
     56      * Wrapped session outbut buffer.
     57      */
     58     private final SessionOutputBuffer out;
     59 
     60     /**
     61      * The maximum number of bytes that can be written the stream. Subsequent
     62      * write operations will be ignored.
     63      */
     64     private final long contentLength;
     65 
     66     /** Total bytes written */
     67     private long total = 0;
     68 
     69     /** True if the stream is closed. */
     70     private boolean closed = false;
     71 
     72     /**
     73      * Creates a new length limited stream
     74      *
     75      * @param out The data transmitter to wrap
     76      * @param contentLength The maximum number of bytes that can be written to
     77      * the stream. Subsequent write operations will be ignored.
     78      *
     79      * @since 4.0
     80      */
     81     public ContentLengthOutputStream(final SessionOutputBuffer out, long contentLength) {
     82         super();
     83         if (out == null) {
     84             throw new IllegalArgumentException("Session output buffer may not be null");
     85         }
     86         if (contentLength < 0) {
     87             throw new IllegalArgumentException("Content length may not be negative");
     88         }
     89         this.out = out;
     90         this.contentLength = contentLength;
     91     }
     92 
     93     /**
     94      * <p>Does not close the underlying socket output.</p>
     95      *
     96      * @throws IOException If an I/O problem occurs.
     97      */
     98     public void close() throws IOException {
     99         if (!this.closed) {
    100             this.closed = true;
    101             this.out.flush();
    102         }
    103     }
    104 
    105     public void flush() throws IOException {
    106         this.out.flush();
    107     }
    108 
    109     public void write(byte[] b, int off, int len) throws IOException {
    110         if (this.closed) {
    111             throw new IOException("Attempted write to closed stream.");
    112         }
    113         if (this.total < this.contentLength) {
    114             long max = this.contentLength - this.total;
    115             if (len > max) {
    116                 len = (int) max;
    117             }
    118             this.out.write(b, off, len);
    119             this.total += len;
    120         }
    121     }
    122 
    123     public void write(byte[] b) throws IOException {
    124         write(b, 0, b.length);
    125     }
    126 
    127     public void write(int b) throws IOException {
    128         if (this.closed) {
    129             throw new IOException("Attempted write to closed stream.");
    130         }
    131         if (this.total < this.contentLength) {
    132             this.out.write(b);
    133             this.total++;
    134         }
    135     }
    136 
    137 }
    138