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.http.entity.mime.content;
29  
30  import java.io.IOException;
31  import java.io.InputStream;
32  import java.io.OutputStream;
33  
34  import org.apache.http.entity.ContentType;
35  import org.apache.http.entity.mime.MIME;
36  import org.apache.http.entity.mime.MultipartEntityBuilder;
37  import org.apache.http.util.Args;
38  
39  /**
40   * Binary body part backed by an input stream.
41   *
42   * @see MultipartEntityBuilder
43   *
44   * @since 4.0
45   */
46  public class InputStreamBody extends AbstractContentBody {
47  
48      private final InputStream in;
49      private final String filename;
50  
51      /**
52       * @since 4.1
53       *
54       * @deprecated (4.3) use {@link InputStreamBody#InputStreamBody(InputStream, ContentType,
55       *  String)} or {@link MultipartEntityBuilder}
56       */
57      @Deprecated
58      public InputStreamBody(final InputStream in, final String mimeType, final String filename) {
59          this(in, ContentType.create(mimeType), filename);
60      }
61  
62      public InputStreamBody(final InputStream in, final String filename) {
63          this(in, ContentType.DEFAULT_BINARY, filename);
64      }
65  
66      /**
67       * @since 4.3
68       */
69      public InputStreamBody(final InputStream in, final ContentType contentType, final String filename) {
70          super(contentType);
71          Args.notNull(in, "Input stream");
72          this.in = in;
73          this.filename = filename;
74      }
75  
76      /**
77       * @since 4.3
78       */
79      public InputStreamBody(final InputStream in, final ContentType contentType) {
80          this(in, contentType, null);
81      }
82  
83      public InputStream getInputStream() {
84          return this.in;
85      }
86  
87      public void writeTo(final OutputStream out) throws IOException {
88          Args.notNull(out, "Output stream");
89          try {
90              final byte[] tmp = new byte[4096];
91              int l;
92              while ((l = this.in.read(tmp)) != -1) {
93                  out.write(tmp, 0, l);
94              }
95              out.flush();
96          } finally {
97              this.in.close();
98          }
99      }
100 
101     public String getTransferEncoding() {
102         return MIME.ENC_BINARY;
103     }
104 
105     public long getContentLength() {
106         return -1;
107     }
108 
109     public String getFilename() {
110         return this.filename;
111     }
112 
113 }