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.File;
31 import java.io.FileInputStream;
32 import java.io.IOException;
33 import java.io.InputStream;
34 import java.io.OutputStream;
35
36 import org.apache.hc.core5.http.ContentType;
37 import org.apache.hc.core5.util.Args;
38
39 /**
40 * Binary body part backed by a file.
41 *
42 * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder
43 *
44 * @since 4.0
45 */
46 public class FileBody extends AbstractContentBody {
47
48 private final File file;
49 private final String filename;
50
51 public FileBody(final File file) {
52 this(file, ContentType.DEFAULT_BINARY, file != null ? file.getName() : null);
53 }
54
55 /**
56 * @since 4.3
57 */
58 public FileBody(final File file, final ContentType contentType, final String filename) {
59 super(contentType);
60 Args.notNull(file, "File");
61 this.file = file;
62 this.filename = filename == null ? file.getName() : filename;
63 }
64
65 /**
66 * @since 4.3
67 */
68 public FileBody(final File file, final ContentType contentType) {
69 this(file, contentType, file != null ? file.getName() : null);
70 }
71
72 public InputStream getInputStream() throws IOException {
73 return new FileInputStream(this.file);
74 }
75
76 @Override
77 public void writeTo(final OutputStream out) throws IOException {
78 Args.notNull(out, "Output stream");
79 try (InputStream in = new FileInputStream(this.file)) {
80 final byte[] tmp = new byte[4096];
81 int l;
82 while ((l = in.read(tmp)) != -1) {
83 out.write(tmp, 0, l);
84 }
85 out.flush();
86 }
87 }
88
89 @Override
90 public long getContentLength() {
91 return this.file.length();
92 }
93
94 @Override
95 public String getFilename() {
96 return filename;
97 }
98
99 public File getFile() {
100 return this.file;
101 }
102
103 }