org.mule.module.apikit.uri

Class URICoder

java.lang.Object

org.mule.module.apikit.uri.URICoder

public class URICoder
extends Object

An encoder/decoder for use by URI templates.

Only unreserved characters according to RFC 3986 do not need to be encoded within a variable:

 unreserved = ALPHA / DIGIT / '-' / '.' / '_' / '˜';
 

This encoder/decoder should be designed so that URI which contain only unreserved characters are processed faster.

Version:

11 June 2009

Author:

Christophe Lauret

See Also:

RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax, RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax - Appendix A. Collected ABNF for URI, UAX #15: Unicode Normalization

Method Summary

Modifier and Type	Method and Description
static String	decode(String s) Decode the string as valid URI fragment.
static String	encode(String s, Set<Character> chars) Encodes the string as valid URI fragment.
static String	encodeRequestPath(String rawRequestPath)

Methods inherited from class java.lang.Object

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

Method Detail

encodeRequestPath

public static String encodeRequestPath(String rawRequestPath)
                                throws ApikitRuntimeException

Parameters:

rawRequestPath - request path with original encoding /api/myEndpoint

Returns:

@rawRequestPath with encoded special characters if found

Throws:

ApikitRuntimeException - when bad encoding detected

encode

public static String encode(String s,
                            Set<Character> chars)

Encodes the string as valid URI fragment.

This encoder will percent-encode all but unreserved characters.

Parameters:

s - The string to encode.

chars - An ASCII set of characters that should not be encoded if found in the string.

Returns:

The corresponding encoded string.

decode

public static String decode(String s)

Decode the string as valid URI fragment.

Parameters:

s - The string to decode.

Returns:

The corresponding decoded string.