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