/*
    * ====================================================================
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  package org.apache.http.nio.entity;
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.OutputStream;
  
  import org.apache.http.HttpEntity;
  import org.apache.http.annotation.NotThreadSafe;
  import org.apache.http.entity.HttpEntityWrapper;
  import org.apache.http.nio.ContentDecoder;
  import org.apache.http.nio.IOControl;
  import org.apache.http.nio.protocol.BasicAsyncRequestConsumer;
  import org.apache.http.nio.protocol.BasicAsyncResponseConsumer;
  import org.apache.http.nio.util.ByteBufferAllocator;
  import org.apache.http.nio.util.SimpleInputBuffer;
  
  /**
   * A {@link ConsumingNHttpEntity} that consumes content into a buffer. The
   * content can be retrieved as an InputStream via
   * {@link HttpEntity#getContent()}, or written to an output stream via
   * {@link HttpEntity#writeTo(OutputStream)}.
   *
   * @since 4.0
   *
   * @deprecated (4.2) use {@link BasicAsyncRequestConsumer} or {@link BasicAsyncResponseConsumer}
   */
  @NotThreadSafe
  @Deprecated
  public class BufferingNHttpEntity extends HttpEntityWrapper implements
          ConsumingNHttpEntity {
  
      private final static int BUFFER_SIZE = 2048;
  
      private final SimpleInputBuffer buffer;
      private boolean finished;
      private boolean consumed;
  
      public BufferingNHttpEntity(
              final HttpEntity httpEntity,
              final ByteBufferAllocator allocator) {
          super(httpEntity);
          this.buffer = new SimpleInputBuffer(BUFFER_SIZE, allocator);
      }
  
      public void consumeContent(
              final ContentDecoder decoder,
              final IOControl ioctrl) throws IOException {
          this.buffer.consumeContent(decoder);
          if (decoder.isCompleted()) {
              this.finished = true;
          }
      }
  
      public void finish() {
          this.finished = true;
      }
  
      @Override
      public void consumeContent() throws IOException {
      }
  
      /**
       * Obtains entity's content as {@link InputStream}.
       *
       *  @throws IllegalStateException if content of the entity has not been
       *    fully received or has already been consumed.
       */
      @Override
      public InputStream getContent() throws IOException {
          if (!this.finished) {
              throw new IllegalStateException("Entity content has not been fully received");
          }
         if (this.consumed) {
             throw new IllegalStateException("Entity content has been consumed");
         }
         this.consumed = true;
         return new ContentInputStream(this.buffer);
     }
 
     @Override
     public boolean isRepeatable() {
         return false;
     }
 
     @Override
     public boolean isStreaming() {
         return true;
     }
 
     @Override
     public void writeTo(final OutputStream outstream) throws IOException {
         if (outstream == null) {
             throw new IllegalArgumentException("Output stream may not be null");
         }
         InputStream instream = getContent();
         byte[] buffer = new byte[BUFFER_SIZE];
         int l;
         // consume until EOF
         while ((l = instream.read(buffer)) != -1) {
             outstream.write(buffer, 0, l);
         }
     }
 
 }