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.hc.client5.http.entity.mime;
29  
30  import java.io.IOException;
31  import java.io.OutputStream;
32  import java.nio.charset.Charset;
33  import java.nio.charset.StandardCharsets;
34  import java.util.List;
35  
36  class HttpRFC6532Multipart extends AbstractMultipartFormat {
37  
38      private final List<MultipartPart> parts;
39  
40      /**
41       * Constructs a new instance of {@code HttpRFC6532Multipart}.
42       *
43       * @param charset   The charset to use for the message.
44       * @param boundary  The boundary string to use for the message.
45       * @param parts     The list of parts that make up the message.
46       * @param preamble  The preamble to include at the beginning of the message, or {@code null} if none.
47       * @param epilogue  The epilogue to include at the end of the message, or {@code null} if none.
48       */
49      public HttpRFC6532Multipart(
50              final Charset charset,
51              final String boundary,
52              final List<MultipartPart> parts,
53              final String preamble,
54              final String epilogue) {
55          super(charset, boundary, preamble, epilogue);
56          this.parts = parts;
57      }
58  
59      /**
60       * Constructs a new instance of {@code HttpRFC6532Multipart} with the given charset, boundary, and parts.
61       *
62       * @param charset the charset to use.
63       * @param boundary the boundary string to use.
64       * @param parts the list of parts to include in the multipart message.
65       */
66      public HttpRFC6532Multipart(
67              final Charset charset,
68              final String boundary,
69              final List<MultipartPart> parts) {
70          this(charset,boundary,parts,null, null);
71      }
72  
73      @Override
74      public List<MultipartPart> getParts() {
75          return this.parts;
76      }
77  
78      @Override
79      protected void formatMultipartHeader(
80          final MultipartPart part,
81          final OutputStream out) throws IOException {
82  
83          // For RFC6532, we output all fields with UTF-8 encoding.
84          final Header header = part.getHeader();
85          for (final MimeField field: header) {
86              writeField(field, StandardCharsets.UTF_8, out);
87          }
88      }
89  
90  }