co.codewizards.cloudstore.core.util

Class UrlEncoder

java.lang.Object

co.codewizards.cloudstore.core.util.UrlEncoder

public final class UrlEncoder
extends Object

URL-encoder encoding all special characters (that cannot be left unchanged) as "%...".

In contrast to the URLEncoder, this class does not encode ' ' (space) space as '+' (plus)!

Additionally, this class does not use the default encoding, but always UTF-8, if not specified otherwise.

The reason for this class is that File.toURI() does not encode a "+" sign. Therefore, our URL-encoding and decoding must not handle the "+" specifically.

Another reason is JERSEY-417. I originally used org.glassfish.jersey.uri.UriComponent.encode(String, Type) at some code locations, but since not all code locations have a dependency on Jersey, I decided to switch consistently everywhere to UrlEncoder and UrlDecoder.

This class was copied from URLEncoder and changed to fit our needs.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

See Also:

UrlDecoder

Method Summary

Modifier and Type	Method and Description
static String	encode(String s) Translates a string into application/x-www-form-urlencoded format using UTF-8.
static String	encode(String s, Charset charset) Deprecated. UTF-8 should be used; it is thus recommended to invoke encode(String) instead.
static String	encode(String s, String enc) Deprecated. UTF-8 should be used; it is thus recommended to invoke encode(String) instead.

Methods inherited from class java.lang.Object

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

Method Detail

encode

public static String encode(String s)

Translates a string into application/x-www-form-urlencoded format using UTF-8.

Parameters:

s - String to be translated.

encode

@Deprecated
public static String encode(String s,
                                        String enc)
                                 throws UnsupportedEncodingException

Deprecated. UTF-8 should be used; it is thus recommended to invoke encode(String) instead.

Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme. This method uses the supplied encoding scheme to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

s - String to be translated.

enc - The name of a supported character encoding.

Returns:

the translated String.

Throws:

UnsupportedEncodingException - If the named encoding is not supported

See Also:

UrlDecoder.decode(String, String)

encode

@Deprecated
public static String encode(String s,
                                        Charset charset)

Deprecated. UTF-8 should be used; it is thus recommended to invoke encode(String) instead.

Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme. This method uses the supplied encoding scheme to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

s - String to be translated.

charset - The character encoding.

Returns:

the translated String.

Throws:

UnsupportedEncodingException - If the named encoding is not supported

See Also:

UrlDecoder.decode(String, Charset)