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.ByteArrayInputStream;
michael@0: import java.io.IOException;
michael@0: import java.io.InputStream;
michael@0: import java.io.OutputStream;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpEntity;
michael@0: import ch.boye.httpclientandroidlib.util.EntityUtils;
michael@0: 
michael@0: /**
michael@0:  * A wrapping entity that buffers it content if necessary.
michael@0:  * The buffered entity is always repeatable.
michael@0:  * If the wrapped entity is repeatable itself, calls are passed through.
michael@0:  * If the wrapped entity is not repeatable, the content is read into a
michael@0:  * buffer once and provided from there as often as required.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class BufferedHttpEntity extends HttpEntityWrapper {
michael@0: 
michael@0:     private final byte[] buffer;
michael@0: 
michael@0:     /**
michael@0:      * Creates a new buffered entity wrapper.
michael@0:      *
michael@0:      * @param entity   the entity to wrap, not null
michael@0:      * @throws IllegalArgumentException if wrapped is null
michael@0:      */
michael@0:     public BufferedHttpEntity(final HttpEntity entity) throws IOException {
michael@0:         super(entity);
michael@0:         if (!entity.isRepeatable() || entity.getContentLength() < 0) {
michael@0:             this.buffer = EntityUtils.toByteArray(entity);
michael@0:         } else {
michael@0:             this.buffer = null;
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     public long getContentLength() {
michael@0:         if (this.buffer != null) {
michael@0:             return this.buffer.length;
michael@0:         } else {
michael@0:             return wrappedEntity.getContentLength();
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     public InputStream getContent() throws IOException {
michael@0:         if (this.buffer != null) {
michael@0:             return new ByteArrayInputStream(this.buffer);
michael@0:         } else {
michael@0:             return wrappedEntity.getContent();
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Tells that this entity does not have to be chunked.
michael@0:      *
michael@0:      * @return  <code>false</code>
michael@0:      */
michael@0:     public boolean isChunked() {
michael@0:         return (buffer == null) && wrappedEntity.isChunked();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Tells that this entity is repeatable.
michael@0:      *
michael@0:      * @return  <code>true</code>
michael@0:      */
michael@0:     public boolean isRepeatable() {
michael@0:         return true;
michael@0:     }
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:         if (this.buffer != null) {
michael@0:             outstream.write(this.buffer);
michael@0:         } else {
michael@0:             wrappedEntity.writeTo(outstream);
michael@0:         }
michael@0:     }
michael@0: 
michael@0: 
michael@0:     // non-javadoc, see interface HttpEntity
michael@0:     public boolean isStreaming() {
michael@0:         return (buffer == null) && wrappedEntity.isStreaming();
michael@0:     }
michael@0: 
michael@0: } // class BufferedHttpEntity