michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  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, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations 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: package ch.boye.httpclientandroidlib.client.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: import ch.boye.httpclientandroidlib.HttpEntity;
michael@0: import ch.boye.httpclientandroidlib.entity.HttpEntityWrapper;
michael@0: 
michael@0: /**
michael@0:  * Common base class for decompressing {@link HttpEntity} implementations.
michael@0:  *
michael@0:  * @since 4.1
michael@0:  */
michael@0: abstract class DecompressingEntity extends HttpEntityWrapper {
michael@0: 
michael@0:     /**
michael@0:      * Default buffer size.
michael@0:      */
michael@0:     private static final int BUFFER_SIZE = 1024 * 2;
michael@0: 
michael@0:     /**
michael@0:      * DecompressingEntities are not repeatable, so they will return the same
michael@0:      * InputStream instance when {@link #getContent()} is called.
michael@0:      */
michael@0:     private InputStream content;
michael@0: 
michael@0:     /**
michael@0:      * Creates a new {@link DecompressingEntity}.
michael@0:      *
michael@0:      * @param wrapped
michael@0:      *            the non-null {@link HttpEntity} to be wrapped
michael@0:      */
michael@0:     public DecompressingEntity(final HttpEntity wrapped) {
michael@0:         super(wrapped);
michael@0:     }
michael@0: 
michael@0:     abstract InputStream getDecompressingInputStream(final InputStream wrapped) throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     @Override
michael@0:     public InputStream getContent() throws IOException {
michael@0:         if (wrappedEntity.isStreaming()) {
michael@0:             if (content == null) {
michael@0:                 content = getDecompressingInputStream(wrappedEntity.getContent());
michael@0:             }
michael@0:             return content;
michael@0:         } else {
michael@0:             return getDecompressingInputStream(wrappedEntity.getContent());
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     @Override
michael@0:     public void writeTo(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:             byte[] buffer = new byte[BUFFER_SIZE];
michael@0: 
michael@0:             int l;
michael@0: 
michael@0:             while ((l = instream.read(buffer)) != -1) {
michael@0:                 outstream.write(buffer, 0, l);
michael@0:             }
michael@0:         } finally {
michael@0:             instream.close();
michael@0:         }
michael@0:     }
michael@0: 
michael@0: }