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; 28 29 import java.nio.charset.Charset; 30 import java.util.List; 31 32 import org.apache.hc.core5.http.ContentType; 33 import org.apache.hc.core5.http.NameValuePair; 34 import org.apache.hc.core5.http.io.entity.StringEntity; 35 import org.apache.hc.core5.net.WWWFormCodec; 36 37 /** 38 * An entity composed of a list of url-encoded pairs. 39 * This is typically useful while sending an HTTP POST request. 40 * 41 * @since 4.0 42 */ 43 public class UrlEncodedFormEntity extends StringEntity { 44 45 /** 46 * Constructs a new {@link UrlEncodedFormEntity} with the list 47 * of parameters in the specified encoding. 48 * 49 * @param parameters iterable collection of name/value pairs 50 * @param charset encoding the name/value pairs be encoded with 51 * 52 * @since 4.2 53 */ 54 public UrlEncodedFormEntity( 55 final Iterable<? extends NameValuePair> parameters, 56 final Charset charset) { 57 super(WWWFormCodec.format( 58 parameters, 59 charset != null ? charset : ContentType.APPLICATION_FORM_URLENCODED.getCharset()), 60 charset != null ? ContentType.APPLICATION_FORM_URLENCODED.withCharset(charset) : ContentType.APPLICATION_FORM_URLENCODED); 61 } 62 63 /** 64 * Constructs a new {@link UrlEncodedFormEntity} with the list 65 * of parameters with the default encoding of {@link ContentType#APPLICATION_FORM_URLENCODED} 66 * 67 * @param parameters list of name/value pairs 68 */ 69 public UrlEncodedFormEntity (final List <? extends NameValuePair> parameters){ 70 this(parameters, null); 71 } 72 73 /** 74 * Constructs a new {@link UrlEncodedFormEntity} with the list 75 * of parameters with the default encoding of {@link ContentType#APPLICATION_FORM_URLENCODED} 76 * 77 * @param parameters iterable collection of name/value pairs 78 * 79 * @since 4.2 80 */ 81 public UrlEncodedFormEntity ( 82 final Iterable <? extends NameValuePair> parameters) { 83 this(parameters, null); 84 } 85 86 }