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;
29
30 import org.apache.http.entity.mime.content.ContentBody;
31 import org.apache.http.util.Args;
32
33 /**
34 * FormBodyPart class represents a content body that can be used as a part of multipart encoded
35 * entities. This class automatically populates the header with standard fields based on
36 * the content description of the enclosed body.
37 *
38 * @since 4.0
39 */
40 public class FormBodyPart {
41
42 private final String name;
43 private final Header header;
44
45 private final ContentBody body;
46
47 public FormBodyPart(final String name, final ContentBody body) {
48 super();
49 Args.notNull(name, "Name");
50 Args.notNull(body, "Body");
51 this.name = name;
52 this.body = body;
53 this.header = new Header();
54
55 generateContentDisp(body);
56 generateContentType(body);
57 generateTransferEncoding(body);
58 }
59
60 public String getName() {
61 return this.name;
62 }
63
64 public ContentBody getBody() {
65 return this.body;
66 }
67
68 public Header getHeader() {
69 return this.header;
70 }
71
72 public void addField(final String name, final String value) {
73 Args.notNull(name, "Field name");
74 this.header.addField(new MinimalField(name, value));
75 }
76
77 protected void generateContentDisp(final ContentBody body) {
78 final StringBuilder buffer = new StringBuilder();
79 buffer.append("form-data; name=\"");
80 buffer.append(getName());
81 buffer.append("\"");
82 if (body.getFilename() != null) {
83 buffer.append("; filename=\"");
84 buffer.append(body.getFilename());
85 buffer.append("\"");
86 }
87 addField(MIME.CONTENT_DISPOSITION, buffer.toString());
88 }
89
90 protected void generateContentType(final ContentBody body) {
91 final StringBuilder buffer = new StringBuilder();
92 buffer.append(body.getMimeType()); // MimeType cannot be null
93 if (body.getCharset() != null) { // charset may legitimately be null
94 buffer.append("; charset=");
95 buffer.append(body.getCharset());
96 }
97 addField(MIME.CONTENT_TYPE, buffer.toString());
98 }
99
100 protected void generateTransferEncoding(final ContentBody body) {
101 addField(MIME.CONTENT_TRANSFER_ENC, body.getTransferEncoding()); // TE cannot be null
102 }
103
104 }