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 generic streamed, non-repeatable entity that obtains its content
michael@0:  * from an {@link InputStream}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class BasicHttpEntity extends AbstractHttpEntity {
michael@0: 
michael@0:     private InputStream content;
michael@0:     private long length;
michael@0: 
michael@0:     /**
michael@0:      * Creates a new basic entity.
michael@0:      * The content is initially missing, the content length
michael@0:      * is set to a negative number.
michael@0:      */
michael@0:     public BasicHttpEntity() {
michael@0:         super();
michael@0:         this.length = -1;
michael@0:     }
michael@0: 
michael@0:     public long getContentLength() {
michael@0:         return this.length;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Obtains the content, once only.
michael@0:      *
michael@0:      * @return  the content, if this is the first call to this method
michael@0:      *          since {@link #setContent setContent} has been called
michael@0:      *
michael@0:      * @throws IllegalStateException
michael@0:      *          if the content has not been provided
michael@0:      */
michael@0:     public InputStream getContent() throws IllegalStateException {
michael@0:         if (this.content == null) {
michael@0:             throw new IllegalStateException("Content has not been provided");
michael@0:         }
michael@0:         return this.content;
michael@0: 
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Tells that this entity is not repeatable.
michael@0:      *
michael@0:      * @return <code>false</code>
michael@0:      */
michael@0:     public boolean isRepeatable() {
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Specifies the length of the content.
michael@0:      *
michael@0:      * @param len       the number of bytes in the content, or
michael@0:      *                  a negative number to indicate an unknown length
michael@0:      */
michael@0:     public void setContentLength(long len) {
michael@0:         this.length = len;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Specifies the content.
michael@0:      *
michael@0:      * @param instream          the stream to return with the next call to
michael@0:      *                          {@link #getContent getContent}
michael@0:      */
michael@0:     public void setContent(final InputStream instream) {
michael@0:         this.content = instream;
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 = getContent();
michael@0:         try {
michael@0:             int l;
michael@0:             byte[] tmp = new byte[2048];
michael@0:             while ((l = instream.read(tmp)) != -1) {
michael@0:                 outstream.write(tmp, 0, l);
michael@0:             }
michael@0:         } finally {
michael@0:             instream.close();
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     public boolean isStreaming() {
michael@0:         return this.content != null;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Closes the content InputStream.
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 (content != null) {
michael@0:             content.close(); // reads to the end of the entity
michael@0:         }
michael@0:     }
michael@0: 
michael@0: }