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