1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util/EncodingUtil.java,v 1.1.2.1 2003/07/15 12:56:34 mbecke Exp $
3 * $Revision: 1.1.2.1 $
4 * $Date: 2003/07/15 12:56:34 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63 package org.apache.commons.httpclient.util;
64
65 import java.util.BitSet;
66
67 import org.apache.commons.httpclient.NameValuePair;
68 import org.apache.commons.httpclient.URIException;
69 import org.apache.commons.logging.Log;
70 import org.apache.commons.logging.LogFactory;
71
72 /***
73 * The home for utility methods that handle various encoding tasks.
74 *
75 * @author Michael Becke
76 *
77 * @since 2.0 final
78 */
79 public class EncodingUtil {
80
81 /*** Log object for this class. */
82 private static final Log LOG = LogFactory.getLog(EncodingUtil.class);
83
84 /***
85 * BitSet of www-form-url safe characters.
86 */
87 private static final BitSet WWW_FORM_URL = new BitSet(256);
88
89 // Static initializer for www_form_url
90 static {
91 // alpha characters
92 for (int i = 'a'; i <= 'z'; i++) {
93 WWW_FORM_URL.set(i);
94 }
95 for (int i = 'A'; i <= 'Z'; i++) {
96 WWW_FORM_URL.set(i);
97 }
98 // numeric characters
99 for (int i = '0'; i <= '9'; i++) {
100 WWW_FORM_URL.set(i);
101 }
102 // blank to be replaced with +
103 WWW_FORM_URL.set(' ');
104 WWW_FORM_URL.set('-');
105 WWW_FORM_URL.set('_');
106 WWW_FORM_URL.set('.');
107 WWW_FORM_URL.set('*');
108 }
109
110 /***
111 * Form-urlencoding routine.
112 *
113 * The default encoding for all forms is `application/x-www-form-urlencoded'.
114 * A form data set is represented in this media type as follows:
115 *
116 * The form field names and values are escaped: space characters are replaced
117 * by `+', and then reserved characters are escaped as per [URL]; that is,
118 * non-alphanumeric characters are replaced by `%HH', a percent sign and two
119 * hexadecimal digits representing the ASCII code of the character. Line breaks,
120 * as in multi-line text field values, are represented as CR LF pairs, i.e. `%0D%0A'.
121 *
122 * @param pairs the values to be encoded
123 * @param charset the character set of pairs to be encoded
124 *
125 * @return the urlencoded pairs
126 *
127 * @since 2.0 final
128 */
129 public static String formUrlEncode(NameValuePair[] pairs, String charset) {
130
131 StringBuffer buf = new StringBuffer();
132 for (int i = 0; i < pairs.length; i++) {
133 if (pairs[i].getName() != null) {
134 if (i > 0) {
135 buf.append("&");
136 }
137 String queryName = pairs[i].getName();
138 try {
139 queryName = URIUtil.encode(queryName, WWW_FORM_URL, charset).replace(' ', '+');
140 } catch (URIException urie) {
141 LOG.error("Error encoding pair name: " + queryName, urie);
142 }
143 buf.append(queryName);
144 buf.append("=");
145 if (pairs[i].getValue() != null) {
146 String queryValue = pairs[i].getValue();
147 try {
148 queryValue = URIUtil.encode(
149 queryValue,
150 WWW_FORM_URL,
151 charset
152 ).replace(' ', '+');
153 } catch (URIException urie) {
154 LOG.error("Error encoding pair value: " + queryValue, urie);
155 }
156 buf.append(queryValue);
157 }
158 }
159 }
160 return buf.toString();
161 }
162
163 /***
164 * This class should not be instantiated.
165 */
166 private EncodingUtil() {
167 }
168
169 }
This page was automatically generated by Maven