michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.entity;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.io.InputStream;
michael@0: import java.io.OutputStream;
michael@0: 
michael@0: /**
michael@0:  * A streamed, non-repeatable entity that obtains its content from
michael@0:  * an {@link InputStream}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class InputStreamEntity extends AbstractHttpEntity {
michael@0: 
michael@0:     private final static int BUFFER_SIZE = 2048;
michael@0: 
michael@0:     private final InputStream content;
michael@0:     private final long length;
michael@0: 
michael@0:     public InputStreamEntity(final InputStream instream, long length) {
michael@0:         super();
michael@0:         if (instream == null) {
michael@0:             throw new IllegalArgumentException("Source input stream may not be null");
michael@0:         }
michael@0:         this.content = instream;
michael@0:         this.length = length;
michael@0:     }
michael@0: 
michael@0:     public boolean isRepeatable() {
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     public long getContentLength() {
michael@0:         return this.length;
michael@0:     }
michael@0: 
michael@0:     public InputStream getContent() throws IOException {
michael@0:         return this.content;
michael@0:     }
michael@0: 
michael@0:     public void writeTo(final OutputStream outstream) throws IOException {
michael@0:         if (outstream == null) {
michael@0:             throw new IllegalArgumentException("Output stream may not be null");
michael@0:         }
michael@0:         InputStream instream = this.content;
michael@0:         try {
michael@0:             byte[] buffer = new byte[BUFFER_SIZE];
michael@0:             int l;
michael@0:             if (this.length < 0) {
michael@0:                 // consume until EOF
michael@0:                 while ((l = instream.read(buffer)) != -1) {
michael@0:                     outstream.write(buffer, 0, l);
michael@0:                 }
michael@0:             } else {
michael@0:                 // consume no more than length
michael@0:                 long remaining = this.length;
michael@0:                 while (remaining > 0) {
michael@0:                     l = instream.read(buffer, 0, (int)Math.min(BUFFER_SIZE, remaining));
michael@0:                     if (l == -1) {
michael@0:                         break;
michael@0:                     }
michael@0:                     outstream.write(buffer, 0, l);
michael@0:                     remaining -= l;
michael@0:                 }
michael@0:             }
michael@0:         } finally {
michael@0:             instream.close();
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     public boolean isStreaming() {
michael@0:         return true;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @deprecated Either use {@link #getContent()} and call {@link java.io.InputStream#close()} on that;
michael@0:      * otherwise call {@link #writeTo(OutputStream)} which is required to free the resources.
michael@0:      */
michael@0:     public void consumeContent() throws IOException {
michael@0:         // If the input stream is from a connection, closing it will read to
michael@0:         // the end of the content. Otherwise, we don't care what it does.
michael@0:         this.content.close();
michael@0:     }
michael@0: 
michael@0: }