Home | History | Annotate | Download | only in entity
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/entity/UrlEncodedFormEntity.java $
      3  * $Revision: 655107 $
      4  * $Date: 2008-05-10 08:20:42 -0700 (Sat, 10 May 2008) $
      5  *
      6  * ====================================================================
      7  *
      8  *  Licensed to the Apache Software Foundation (ASF) under one or more
      9  *  contributor license agreements.  See the NOTICE file distributed with
     10  *  this work for additional information regarding copyright ownership.
     11  *  The ASF licenses this file to You under the Apache License, Version 2.0
     12  *  (the "License"); you may not use this file except in compliance with
     13  *  the License.  You may obtain a copy of the License at
     14  *
     15  *      http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  *  Unless required by applicable law or agreed to in writing, software
     18  *  distributed under the License is distributed on an "AS IS" BASIS,
     19  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     20  *  See the License for the specific language governing permissions and
     21  *  limitations under the License.
     22  * ====================================================================
     23  *
     24  * This software consists of voluntary contributions made by many
     25  * individuals on behalf of the Apache Software Foundation.  For more
     26  * information on the Apache Software Foundation, please see
     27  * <http://www.apache.org/>.
     28  *
     29  */
     30 
     31 package org.apache.http.client.entity;
     32 
     33 import java.io.UnsupportedEncodingException;
     34 import java.util.List;
     35 import org.apache.http.NameValuePair;
     36 import org.apache.http.client.utils.URLEncodedUtils;
     37 import org.apache.http.entity.StringEntity;
     38 import org.apache.http.protocol.HTTP;
     39 
     40 /**
     41  * An entity composed of a list of url-encoded pairs.
     42  * This is typically useful while sending an HTTP POST request.
     43  *
     44  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     45  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     46  *     for further details.
     47  */
     48 @Deprecated
     49 public class UrlEncodedFormEntity extends StringEntity {
     50 
     51     /**
     52      * Constructs a new {@link UrlEncodedFormEntity} with the list
     53      * of parameters in the specified encoding.
     54      *
     55      * @param parameters list of name/value pairs
     56      * @param encoding encoding the name/value pairs be encoded with
     57      * @throws UnsupportedEncodingException if the encoding isn't supported
     58      */
     59     public UrlEncodedFormEntity (
     60         final List <? extends NameValuePair> parameters,
     61         final String encoding) throws UnsupportedEncodingException {
     62         super(URLEncodedUtils.format(parameters, encoding),
     63             encoding);
     64         setContentType(URLEncodedUtils.CONTENT_TYPE);
     65     }
     66 
     67     /**
     68      * Constructs a new {@link UrlEncodedFormEntity} with the list
     69      * of parameters with the default encoding of {@link HTTP#DEFAULT_CONTENT_CHARSET}
     70      *
     71      * @param parameters list of name/value pairs
     72      * @throws UnsupportedEncodingException if the default encoding isn't supported
     73      */
     74     public UrlEncodedFormEntity (
     75         final List <? extends NameValuePair> parameters) throws UnsupportedEncodingException {
     76         super(URLEncodedUtils.format(parameters, HTTP.DEFAULT_CONTENT_CHARSET),
     77             HTTP.DEFAULT_CONTENT_CHARSET);
     78         setContentType(URLEncodedUtils.CONTENT_TYPE);
     79     }
     80 
     81 }
     82