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 package org.apache.hc.client5.http.entity.mime;
28
29 import java.io.IOException;
30 import java.io.OutputStream;
31
32 import org.apache.hc.core5.http.ContentType;
33 import org.apache.hc.core5.util.Args;
34
35 /**
36 * Binary body part backed by a byte array.
37 *
38 * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder
39 *
40 * @since 4.1
41 */
42 public class ByteArrayBody extends AbstractContentBody {
43
44 /**
45 * The contents of the file contained in this part.
46 */
47 private final byte[] data;
48
49 /**
50 * The name of the file contained in this part.
51 */
52 private final String filename;
53
54 /**
55 * @since 4.3
56 */
57 public ByteArrayBody(final byte[] data, final ContentType contentType, final String filename) {
58 super(contentType);
59 this.data = Args.notNull(data, "data");
60 this.filename = filename;
61 }
62
63 /**
64 * Public constructor that creates a new ByteArrayBody.
65 *
66 * @param contentType the {@link ContentType}
67 * @param data the array of byte.
68 *
69 * @since 5.2
70 */
71 public ByteArrayBody(final byte[] data, final ContentType contentType) {
72 this(data, contentType, null);
73 }
74
75 /**
76 * Creates a new ByteArrayBody.
77 *
78 * @param data The contents of the file contained in this part.
79 * @param filename The name of the file contained in this part.
80 */
81 public ByteArrayBody(final byte[] data, final String filename) {
82 this(data, ContentType.APPLICATION_OCTET_STREAM, filename);
83 }
84
85 @Override
86 public String getFilename() {
87 return filename;
88 }
89
90 @Override
91 public void writeTo(final OutputStream out) throws IOException {
92 out.write(data);
93 }
94
95 @Override
96 public String getCharset() {
97 return null;
98 }
99
100 @Override
101 public long getContentLength() {
102 return data.length;
103 }
104
105 }