View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.client5.http.entity.mime;
29  
30  import java.io.IOException;
31  import java.io.InputStream;
32  import java.io.OutputStream;
33  
34  import org.apache.hc.core5.http.ContentType;
35  import org.apache.hc.core5.util.Args;
36  
37  /**
38   * Binary body part backed by an input stream.
39   *
40   * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder
41   *
42   * @since 4.0
43   */
44  public class InputStreamBody extends AbstractContentBody {
45  
46      private final InputStream in;
47      private final String filename;
48      private final long contentLength;
49  
50      public InputStreamBody(final InputStream in, final String filename) {
51          this(in, ContentType.DEFAULT_BINARY, filename);
52      }
53  
54      /**
55       * @since 4.3
56       */
57      public InputStreamBody(final InputStream in, final ContentType contentType, final String filename) {
58          this(in, contentType, filename, -1);
59      }
60  
61      /**
62       * @since 4.6
63       */
64      public InputStreamBody(final InputStream in, final ContentType contentType, final String filename, final long contentLength) {
65          super(contentType);
66          Args.notNull(in, "Input stream");
67          this.in = in;
68          this.filename = filename;
69          this.contentLength = contentLength >= 0 ? contentLength : -1;
70      }
71  
72      /**
73       * @since 4.3
74       */
75      public InputStreamBody(final InputStream in, final ContentType contentType) {
76          this(in, contentType, null);
77      }
78  
79      public InputStream getInputStream() {
80          return this.in;
81      }
82  
83      @Override
84      public void writeTo(final OutputStream out) throws IOException {
85          Args.notNull(out, "Output stream");
86          try {
87              final byte[] tmp = new byte[4096];
88              int l;
89              while ((l = this.in.read(tmp)) != -1) {
90                  out.write(tmp, 0, l);
91              }
92              out.flush();
93          } finally {
94              this.in.close();
95          }
96      }
97  
98      @Override
99      public long getContentLength() {
100         return this.contentLength;
101     }
102 
103     @Override
104     public String getFilename() {
105         return this.filename;
106     }
107 
108 }