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