org.eclipse.jetty.util

Class UrlEncoded

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,List<V>>

org.eclipse.jetty.util.MultiMap<String>

org.eclipse.jetty.util.UrlEncoded

All Implemented Interfaces:

Serializable, Cloneable, Map<String,List<String>>

public class UrlEncoded
extends MultiMap<String>
implements Cloneable

Handles coding of MIME "x-www-form-urlencoded".

This class handles the encoding and decoding for either the query string of a URL or the _content of a POST HTTP request.

Notes

The UTF-8 charset is assumed, unless otherwise defined by either passing a parameter or setting the "org.eclipse.jetty.util.UrlEncoding.charset" System property.

The hashtable either contains String single values, vectors of String or arrays of Strings.

This class is only partially synchronised. In particular, simple get operations are not protected from concurrent updates.

See Also:

URLEncoder, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	ENCODING

Constructor Summary

Constructors

Constructor and Description
UrlEncoded()
UrlEncoded(String query)
UrlEncoded(UrlEncoded url)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
void	decode(String query)
void	decode(String query, Charset charset)
static void	decode88591To(InputStream in, MultiMap<String> map, int maxLength, int maxKeys) Decoded parameters to Map.
static String	decodeString(String encoded, int offset, int length, Charset charset) Decode String with % encoding.
static void	decodeTo(InputStream in, MultiMap<String> map, Charset charset, int maxLength, int maxKeys) Decoded parameters to Map.
static void	decodeTo(InputStream in, MultiMap<String> map, String charset, int maxLength, int maxKeys) Decoded parameters to Map.
static void	decodeTo(String content, MultiMap<String> map, Charset charset, int maxKeys) Decoded parameters to Map.
static void	decodeTo(String content, MultiMap<String> map, String charset, int maxKeys) Decoded parameters to Map.
static void	decodeUtf16To(InputStream in, MultiMap<String> map, int maxLength, int maxKeys)
static void	decodeUtf8To(byte[] raw, int offset, int length, MultiMap<String> map) Decoded parameters to Map.
static void	decodeUtf8To(InputStream in, MultiMap<String> map, int maxLength, int maxKeys) Decoded parameters to Map.
String	encode() Encode Hashtable with % encoding.
String	encode(Charset charset) Encode Hashtable with % encoding.
String	encode(Charset charset, boolean equalsForNullValue) Encode Hashtable with % encoding.
static String	encode(MultiMap<String> map, Charset charset, boolean equalsForNullValue) Encode Hashtable with % encoding.
static String	encodeString(String string) Perform URL encoding.
static String	encodeString(String string, Charset charset) Perform URL encoding.

Methods inherited from class org.eclipse.jetty.util.MultiMap

add, addAllValues, addValues, addValues, containsSimpleValue, getString, getValue, getValues, put, putAllValues, putValues, putValues, removeValue, toString, toStringArrayMap

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

ENCODING

public static final Charset ENCODING

Constructor Detail

UrlEncoded

public UrlEncoded(UrlEncoded url)

UrlEncoded

public UrlEncoded()

UrlEncoded

public UrlEncoded(String query)

Method Detail

decode

public void decode(String query)

decode

public void decode(String query,
          Charset charset)

encode

public String encode()

Encode Hashtable with % encoding.

encode

public String encode(Charset charset)

Encode Hashtable with % encoding.

encode

public String encode(Charset charset,
            boolean equalsForNullValue)

Encode Hashtable with % encoding.

Parameters:

equalsForNullValue - if True, then an '=' is always used, even for parameters without a value. e.g. "blah?a=&b=&c=".

encode

public static String encode(MultiMap<String> map,
            Charset charset,
            boolean equalsForNullValue)

Encode Hashtable with % encoding.

Parameters:

equalsForNullValue - if True, then an '=' is always used, even for parameters without a value. e.g. "blah?a=&b=&c=".

decodeTo

public static void decodeTo(String content,
            MultiMap<String> map,
            String charset,
            int maxKeys)

Decoded parameters to Map.

Parameters:

content - the string containing the encoded parameters

decodeTo

public static void decodeTo(String content,
            MultiMap<String> map,
            Charset charset,
            int maxKeys)

Decoded parameters to Map.

Parameters:

content - the string containing the encoded parameters

decodeUtf8To

public static void decodeUtf8To(byte[] raw,
                int offset,
                int length,
                MultiMap<String> map)

Decoded parameters to Map.

Parameters:

raw - the byte[] containing the encoded parameters

offset - the offset within raw to decode from

length - the length of the section to decode

map - the MultiMap to populate

decode88591To

public static void decode88591To(InputStream in,
                 MultiMap<String> map,
                 int maxLength,
                 int maxKeys)
                          throws IOException

Decoded parameters to Map.

Parameters:

in - InputSteam to read

map - MultiMap to add parameters to

maxLength - maximum number of keys to read or -1 for no limit

Throws:

IOException

decodeUtf8To

public static void decodeUtf8To(InputStream in,
                MultiMap<String> map,
                int maxLength,
                int maxKeys)
                         throws IOException

Decoded parameters to Map.

Parameters:

in - InputSteam to read

map - MultiMap to add parameters to

maxLength - maximum number of keys to read or -1 for no limit

Throws:

IOException

decodeUtf16To

public static void decodeUtf16To(InputStream in,
                 MultiMap<String> map,
                 int maxLength,
                 int maxKeys)
                          throws IOException

Throws:

IOException

decodeTo

public static void decodeTo(InputStream in,
            MultiMap<String> map,
            String charset,
            int maxLength,
            int maxKeys)
                     throws IOException

Decoded parameters to Map.

Parameters:

in - the stream containing the encoded parameters

Throws:

IOException

decodeTo

public static void decodeTo(InputStream in,
            MultiMap<String> map,
            Charset charset,
            int maxLength,
            int maxKeys)
                     throws IOException

Decoded parameters to Map.

Parameters:

in - the stream containing the encoded parameters

Throws:

IOException

decodeString

public static String decodeString(String encoded,
                  int offset,
                  int length,
                  Charset charset)

Decode String with % encoding. This method makes the assumption that the majority of calls will need no decoding.

encodeString

public static String encodeString(String string)

Perform URL encoding.

Parameters:

string -

Returns:

encoded string.

encodeString

public static String encodeString(String string,
                  Charset charset)

Perform URL encoding.

Parameters:

string -

Returns:

encoded string.

clone

public Object clone()

Overrides:

clone in class HashMap<String,List<String>>