org.apache.http.client.utils

Class URLEncodedUtils

java.lang.Object

org.apache.http.client.utils.URLEncodedUtils

@Immutable
public class URLEncodedUtils
extends java.lang.Object

A collection of utilities for encoding URLs.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE The default HTML form content type.

Constructor Summary

Constructors

Constructor and Description
URLEncodedUtils()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static java.lang.String	encPath(java.lang.String content, java.nio.charset.Charset charset) Encode a String using the PATHSAFE set of characters.
(package private) static java.lang.String	encUric(java.lang.String content, java.nio.charset.Charset charset) Encode a String using the URIC set of characters.
(package private) static java.lang.String	encUserInfo(java.lang.String content, java.nio.charset.Charset charset) Encode a String using the USERINFO set of characters.
static java.lang.String	format(java.lang.Iterable<? extends NameValuePair> parameters, char parameterSeparator, java.nio.charset.Charset charset) Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.
static java.lang.String	format(java.lang.Iterable<? extends NameValuePair> parameters, java.nio.charset.Charset charset) Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.
static java.lang.String	format(java.util.List<? extends NameValuePair> parameters, char parameterSeparator, java.lang.String charset) Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.
static java.lang.String	format(java.util.List<? extends NameValuePair> parameters, java.lang.String charset) Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.
static boolean	isEncoded(HttpEntity entity) Returns true if the entity's Content-Type header is application/x-www-form-urlencoded.
static java.util.List<NameValuePair>	parse(CharArrayBuffer buf, java.nio.charset.Charset charset, char... separators) Returns a list of NameValuePairs as parsed from the given string using the given character encoding.
static java.util.List<NameValuePair>	parse(HttpEntity entity) Returns a list of NameValuePairs as parsed from an HttpEntity.
static void	parse(java.util.List<NameValuePair> parameters, java.util.Scanner scanner, java.lang.String charset) Deprecated. (4.4) use parse(String, java.nio.charset.Charset)
static void	parse(java.util.List<NameValuePair> parameters, java.util.Scanner scanner, java.lang.String parameterSepartorPattern, java.lang.String charset) Deprecated. (4.4) use parse(org.apache.http.util.CharArrayBuffer, java.nio.charset.Charset, char...)
static java.util.List<NameValuePair>	parse(java.lang.String s, java.nio.charset.Charset charset) Returns a list of NameValuePairs as parsed from the given string using the given character encoding.
static java.util.List<NameValuePair>	parse(java.lang.String s, java.nio.charset.Charset charset, char... separators) Returns a list of NameValuePairs as parsed from the given string using the given character encoding.
static java.util.List<NameValuePair>	parse(java.net.URI uri, java.lang.String charset) Returns a list of NameValuePairs as built from the URI's query portion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

The default HTML form content type.

See Also:

Constant Field Values

Constructor Detail

URLEncodedUtils

public URLEncodedUtils()

Method Detail

parse

public static java.util.List<NameValuePair> parse(java.net.URI uri,
                                  java.lang.String charset)

Returns a list of NameValuePairs as built from the URI's query portion. For example, a URI of http://example.org/path/to/file?a=1&b=2&c=3 would return a list of three NameValuePairs, one for a=1, one for b=2, and one for c=3. By convention, '&' and ';' are accepted as parameter separators.

This is typically useful while parsing an HTTP PUT. This API is currently only used for testing.

Parameters:

uri - URI to parse

charset - Charset name to use while parsing the query

Returns:

a list of NameValuePair as built from the URI's query portion.

parse

public static java.util.List<NameValuePair> parse(HttpEntity entity)
                                           throws java.io.IOException

Returns a list of NameValuePairs as parsed from an HttpEntity. The encoding is taken from the entity's Content-Encoding header.

This is typically used while parsing an HTTP POST.

Parameters:

entity - The entity to parse

Returns:

a list of NameValuePair as built from the URI's query portion.

Throws:

java.io.IOException - If there was an exception getting the entity's data.

isEncoded

public static boolean isEncoded(HttpEntity entity)

Returns true if the entity's Content-Type header is application/x-www-form-urlencoded.

parse

@Deprecated
public static void parse(java.util.List<NameValuePair> parameters,
                    java.util.Scanner scanner,
                    java.lang.String charset)

Deprecated. (4.4) use parse(String, java.nio.charset.Charset)

Adds all parameters within the Scanner to the list of parameters, as encoded by encoding. For example, a scanner containing the string a=1&b=2&c=3 would add the NameValuePairs a=1, b=2, and c=3 to the list of parameters. By convention, '&' and ';' are accepted as parameter separators.

Parameters:

parameters - List to add parameters to.

scanner - Input that contains the parameters to parse.

charset - Encoding to use when decoding the parameters.

parse

@Deprecated
public static void parse(java.util.List<NameValuePair> parameters,
                    java.util.Scanner scanner,
                    java.lang.String parameterSepartorPattern,
                    java.lang.String charset)

Deprecated. (4.4) use parse(org.apache.http.util.CharArrayBuffer, java.nio.charset.Charset, char...)

Adds all parameters within the Scanner to the list of parameters, as encoded by encoding. For example, a scanner containing the string a=1&b=2&c=3 would add the NameValuePairs a=1, b=2, and c=3 to the list of parameters.

Parameters:

parameters - List to add parameters to.

scanner - Input that contains the parameters to parse.

parameterSepartorPattern - The Pattern string for parameter separators, by convention "[&;]"

charset - Encoding to use when decoding the parameters.

parse

public static java.util.List<NameValuePair> parse(java.lang.String s,
                                  java.nio.charset.Charset charset)

Returns a list of NameValuePairs as parsed from the given string using the given character encoding. By convention, '&' and ';' are accepted as parameter separators.

Parameters:

s - text to parse.

charset - Encoding to use when decoding the parameters.

Returns:

a list of NameValuePair as built from the URI's query portion.

Since:

4.2

parse

public static java.util.List<NameValuePair> parse(java.lang.String s,
                                  java.nio.charset.Charset charset,
                                  char... separators)

Returns a list of NameValuePairs as parsed from the given string using the given character encoding.

Parameters:

s - text to parse.

charset - Encoding to use when decoding the parameters.

separators - element separators.

Returns:

a list of NameValuePair as built from the URI's query portion.

Since:

4.3

parse

public static java.util.List<NameValuePair> parse(CharArrayBuffer buf,
                                  java.nio.charset.Charset charset,
                                  char... separators)

Returns a list of NameValuePairs as parsed from the given string using the given character encoding.

Parameters:

buf - text to parse.

charset - Encoding to use when decoding the parameters.

separators - element separators.

Returns:

a list of NameValuePair as built from the URI's query portion.

Since:

4.4

format

public static java.lang.String format(java.util.List<? extends NameValuePair> parameters,
                      java.lang.String charset)

Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.

Parameters:

parameters - The parameters to include.

charset - The encoding to use.

Returns:

An application/x-www-form-urlencoded string

format

public static java.lang.String format(java.util.List<? extends NameValuePair> parameters,
                      char parameterSeparator,
                      java.lang.String charset)

Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.

Parameters:

parameters - The parameters to include.

parameterSeparator - The parameter separator, by convention, '&' or ';'.

charset - The encoding to use.

Returns:

An application/x-www-form-urlencoded string

Since:

4.3

format

public static java.lang.String format(java.lang.Iterable<? extends NameValuePair> parameters,
                      java.nio.charset.Charset charset)

Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.

Parameters:

parameters - The parameters to include.

charset - The encoding to use.

Returns:

An application/x-www-form-urlencoded string

Since:

4.2

format

public static java.lang.String format(java.lang.Iterable<? extends NameValuePair> parameters,
                      char parameterSeparator,
                      java.nio.charset.Charset charset)

Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.

Parameters:

parameters - The parameters to include.

parameterSeparator - The parameter separator, by convention, '&' or ';'.

charset - The encoding to use.

Returns:

An application/x-www-form-urlencoded string

Since:

4.3

encUserInfo

static java.lang.String encUserInfo(java.lang.String content,
                           java.nio.charset.Charset charset)

Encode a String using the USERINFO set of characters.

Used by URIBuilder to encode the userinfo segment.

Parameters:

content - the string to encode, does not convert space to '+'

charset - the charset to use

Returns:

the encoded string

encUric

static java.lang.String encUric(java.lang.String content,
                       java.nio.charset.Charset charset)

Encode a String using the URIC set of characters.

Used by URIBuilder to encode the query and fragment segments.

Parameters:

content - the string to encode, does not convert space to '+'

charset - the charset to use

Returns:

the encoded string

encPath

static java.lang.String encPath(java.lang.String content,
                       java.nio.charset.Charset charset)

Encode a String using the PATHSAFE set of characters.

Used by URIBuilder to encode path segments.

Parameters:

content - the string to encode, does not convert space to '+'

charset - the charset to use

Returns:

the encoded string