davmail.http

Class URIUtil

java.lang.Object

davmail.http.URIUtil

public class URIUtil
extends Object

Implement encode/decode logic to replace HttpClient 3 URIUtil

Field Summary

Fields

Modifier and Type	Field and Description
protected static BitSet	abs_path URI absolute path.
static BitSet	allowed_abs_path Those characters that are allowed for the abs_path.
static BitSet	allowed_query Those characters that are allowed for the query component.
static BitSet	allowed_within_query Those characters that are allowed within the query component.
protected static BitSet	alpha BitSet for alpha.
protected static BitSet	alphanum BitSet for alphanum (join of alpha & digit).
protected static BitSet	digit BitSet for digit.
protected static BitSet	escaped BitSet for escaped.
protected static BitSet	hex BitSet for hex.
protected static BitSet	mark BitSet for mark.
protected static BitSet	param BitSet for param (alias for pchar).
protected static BitSet	path_segments BitSet for path segments.
protected static BitSet	pchar BitSet for pchar.
protected static BitSet	percent The percent "%" character always has the reserved purpose of being the escape indicator, it must be escaped as "%25" in order to be used as data within a URI.
protected static BitSet	reserved BitSet for reserved.
protected static BitSet	segment BitSet for segment.
protected static BitSet	unreserved Data characters that are allowed in a URI but do not have a reserved purpose are called unreserved.
protected static BitSet	uric BitSet for uric.

Constructor Summary

Constructors

Constructor and Description
URIUtil()

Method Summary

Modifier and Type	Method and Description
static String	decode(String escaped) Decode url encoded string.
static String	encode(String unescaped, BitSet allowed) URL encode string.
static String	encodePath(String unescaped) Encode url path.
static String	encodePathQuery(String unescaped) URL encode path and query string.
static String	encodeWithinQuery(String unescaped) URL encode query string.
static byte[]	getAsciiBytes(String value)
static String	getAsciiString(byte[] bytes) Convert byte array to an ASCII string value.
static byte[]	getBytes(String value)
static String	getString(byte[] bytes) Convert byte array to a UTF-8 string value.

Methods inherited from class java.lang.Object

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

Field Detail

percent

protected static final BitSet percent

The percent "%" character always has the reserved purpose of being the escape indicator, it must be escaped as "%25" in order to be used as data within a URI.

digit

protected static final BitSet digit

BitSet for digit.

 digit    = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" |
            "8" | "9"
 

alpha

protected static final BitSet alpha

BitSet for alpha.

 alpha         = lowalpha | upalpha
 

alphanum

protected static final BitSet alphanum

BitSet for alphanum (join of alpha & digit).

  alphanum      = alpha | digit
 

hex

protected static final BitSet hex

BitSet for hex.

 hex           = digit | "A" | "B" | "C" | "D" | "E" | "F" |
                         "a" | "b" | "c" | "d" | "e" | "f"
 

escaped

protected static final BitSet escaped

BitSet for escaped.

 escaped       = "%" hex hex
 

mark

protected static final BitSet mark

BitSet for mark.

 mark          = "-" | "_" | "." | "!" | "~" | "*" | "'" |
                 "(" | ")"
 

unreserved

protected static final BitSet unreserved

Data characters that are allowed in a URI but do not have a reserved purpose are called unreserved.

 unreserved    = alphanum | mark
 

reserved

protected static final BitSet reserved

BitSet for reserved.

 reserved      = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
                 "$" | ","
 

uric

protected static final BitSet uric

BitSet for uric.

 uric          = reserved | unreserved | escaped
 

pchar

protected static final BitSet pchar

BitSet for pchar.

 pchar         = unreserved | escaped |
                 ":" | "@" | "&" | "=" | "+" | "$" | ","
 

param

protected static final BitSet param

BitSet for param (alias for pchar).

 param         = *pchar
 

segment

protected static final BitSet segment

BitSet for segment.

 segment       = *pchar *( ";" param )
 

path_segments

protected static final BitSet path_segments

BitSet for path segments.

 path_segments = segment *( "/" segment )
 

abs_path

protected static final BitSet abs_path

URI absolute path.

 abs_path      = "/"  path_segments
 

allowed_abs_path

public static final BitSet allowed_abs_path

Those characters that are allowed for the abs_path.

allowed_query

public static final BitSet allowed_query

Those characters that are allowed for the query component.

allowed_within_query

public static final BitSet allowed_within_query

Those characters that are allowed within the query component.

Constructor Detail

URIUtil

public URIUtil()

Method Detail

decode

public static String decode(String escaped)
                     throws IOException

Decode url encoded string.

Parameters:

escaped - encoded string

Returns:

decoded string

Throws:

IOException - on error

encodePath

public static String encodePath(String unescaped)

Encode url path.

Parameters:

unescaped - unencoded path

Returns:

escaped path

encode

public static String encode(String unescaped,
                            BitSet allowed)

URL encode string.

Parameters:

unescaped - unencoded string

allowed - allowed characters bitset

Returns:

encoded string

encodeWithinQuery

public static String encodeWithinQuery(String unescaped)

URL encode query string.

Parameters:

unescaped - unencoded query string

Returns:

encoded string query string

encodePathQuery

public static String encodePathQuery(String unescaped)

URL encode path and query string.

Parameters:

unescaped - unencoded path and query string

Returns:

encoded string path and query string

getBytes

public static byte[] getBytes(String value)

getAsciiBytes

public static byte[] getAsciiBytes(String value)

getAsciiString

public static String getAsciiString(byte[] bytes)

Convert byte array to an ASCII string value.

Parameters:

bytes - byte array

Returns:

ASCII string

getString

public static String getString(byte[] bytes)

Convert byte array to a UTF-8 string value.

Parameters:

bytes - byte array

Returns:

ASCII string