gateway-spi/src/main/java/org/apache/knox/gateway/dispatch/InputStreamEntity.java

/*
 * ====================================================================
 * 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.knox.gateway.dispatch;

import org.apache.http.entity.AbstractHttpEntity;
import org.apache.http.entity.ContentType;
import org.apache.http.util.Args;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * A streamed, non-repeatable entity that obtains its content froman {@link InputStream}.
 * Copied from HttpClient source in order to increase buffer size.
 */
public class InputStreamEntity extends AbstractHttpEntity {

  // A value of 16K results in a significant performance improvement due to better HTTP chunking on the wire.
  protected static final int OUTPUT_BUFFER_SIZE = 16 * 1024;
  private final InputStream content;
  private final long length;

  /**
   * Creates an entity with an unknown length.
   * Equivalent to {@code new InputStreamEntity(instream, -1)}.
   *
   * @param instream input stream
   * @throws IllegalArgumentException if {@code instream} is {@code null}
   */
  public InputStreamEntity( final InputStream instream ) {
    this( instream, -1 );
  }

  /**
   * Creates an entity with a specified content length.
   *
   * @param instream input stream
   * @param length   of the input stream, {@code -1} if unknown
   * @throws IllegalArgumentException if {@code instream} is {@code null}
   */
  public InputStreamEntity( final InputStream instream, final long length ) {
    this( instream, length, null );
  }

  /**
   * Creates an entity with a content type and unknown length.
   * Equivalent to {@code new InputStreamEntity(instream, -1, contentType)}.
   *
   * @param instream    input stream
   * @param contentType content type
   * @throws IllegalArgumentException if {@code instream} is {@code null}
   */
  public InputStreamEntity( final InputStream instream, final ContentType contentType ) {
    this( instream, -1, contentType );
  }

  /**
   * @param instream    input stream
   * @param length      of the input stream, {@code -1} if unknown
   * @param contentType for specifying the {@code Content-Type} header, may be {@code null}
   * @throws IllegalArgumentException if {@code instream} is {@code null}
   */
  public InputStreamEntity( final InputStream instream, final long length, final ContentType contentType ) {
    super();
    this.content = Args.notNull( instream, "Source input stream" );
    this.length = length;
    if( contentType != null ) {
      setContentType( contentType.toString() );
    }
  }

  @Override
  public boolean isRepeatable() {
    return false;
  }

  /**
   * @return the content length or {@code -1} if unknown
   */
  @Override
  public long getContentLength() {
    return this.length;
  }

  @Override
  public InputStream getContent() throws IOException {
    return this.content;
  }

  /**
   * Writes bytes from the {@code InputStream} this entity was constructed
   * with to an {@code OutputStream}.  The content length
   * determines how many bytes are written.  If the length is unknown ({@code -1}), the
   * stream will be completely consumed (to the end of the stream).
   */
  @Override
  public void writeTo(final OutputStream outstream ) throws IOException {
    Args.notNull( outstream, "Output stream" );
    try (InputStream instream = this.content) {
      final byte[] buffer = new byte[OUTPUT_BUFFER_SIZE];
      int l;
      if (this.length < 0) {
        // consume until EOF
        while ((l = instream.read(buffer)) != -1) {
          outstream.write(buffer, 0, l);
        }
      } else {
        // consume no more than length
        long remaining = this.length;
        while (remaining > 0) {
          l = instream.read(buffer, 0, (int) Math.min(OUTPUT_BUFFER_SIZE, remaining));
          if (l == -1) {
            break;
          }
          outstream.write(buffer, 0, l);
          remaining -= l;
        }
      }
    }
  }

  @Override
  public boolean isStreaming() {
    return true;
  }

}