org.mule.runtime.http.api.utils

Class HttpEncoderDecoderUtils

java.lang.Object

org.mule.runtime.http.api.utils.HttpEncoderDecoderUtils

public final class HttpEncoderDecoderUtils
extends Object

Provides helper methods for encoding and decoding http request and response content.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static String	appendQueryParam(String url, String queryParamName, String queryParamValue) Appends a query parameter to an URL that may or may not contain query parameters already.
static org.mule.runtime.api.util.MultiMap<String,String>	decodeQueryString(String queryString) Converts a query-string from a request url into a MultiMap.
static org.mule.runtime.api.util.MultiMap<String,String>	decodeUriParams(String pathWithUriParams, String requestPath) Decodes uri params from a request path
static org.mule.runtime.api.util.MultiMap<String,String>	decodeUrlEncodedBody(String queryString, Charset encoding) Converts an url-encoded body into a MultiMap with a given encoding.
static String	encodeQueryString(Map<String,String> parameters) Converts a map to a request url query-string form.
static String	encodeSpaces(String path) Encodes spaces in a path, replacing them by %20.
static String	encodeString(Map parameters, Charset encoding) Converts a map to a request url query-string form.
static String	extractPath(String uri) Extracts the path (what's left of the ? character) from the passed uri.
static String	extractQueryParams(String uri) Extracts the query parameters (what's right of the ? character) from the passed uri.

Methods inherited from class java.lang.Object

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

Method Detail

extractPath

public static String extractPath(String uri)

Extracts the path (what's left of the ? character) from the passed uri.

Parameters:

uri - the uri to extract the path from

Returns:

the path form the uri

extractQueryParams

public static String extractQueryParams(String uri)

Extracts the query parameters (what's right of the ? character) from the passed uri.

Parameters:

uri - the uri to extract the parameters from

Returns:

the parameters form the uri

decodeQueryString

public static org.mule.runtime.api.util.MultiMap<String,String> decodeQueryString(String queryString)

Converts a query-string from a request url into a MultiMap.

This is the inverse of encodeQueryString(Map).

Parameters:

queryString - the query string to parse

Returns:

a map representation of the queryString

encodeQueryString

public static String encodeQueryString(Map<String,String> parameters)

Converts a map to a request url query-string form.

This is the inverse of decodeQueryString(String).

Parameters:

parameters - a map representation of the queryString

Returns:

the generated query string

decodeUrlEncodedBody

public static org.mule.runtime.api.util.MultiMap<String,String> decodeUrlEncodedBody(String queryString,
                                                                                     Charset encoding)

Converts an url-encoded body into a MultiMap with a given encoding.

This is the inverse of #encodeString(String, Charset).

Parameters:

queryString - the string to parse

encoding - URLDecoder.decode(String, String).

Returns:

a map representation of the queryString

decodeUriParams

public static org.mule.runtime.api.util.MultiMap<String,String> decodeUriParams(String pathWithUriParams,
                                                                                String requestPath)

Decodes uri params from a request path

Parameters:

pathWithUriParams - path with uri param place holders

requestPath - request path

Returns:

a map with the uri params present in the request path with the values decoded.

encodeString

public static String encodeString(Map parameters,
                                  Charset encoding)

Converts a map to a request url query-string form.

This is the inverse of decodeUrlEncodedBody(String, Charset).

Parameters:

parameters - a map representation of the queryString

encoding - URLDecoder.decode(String, String).

Returns:

the generated query string

encodeSpaces

public static String encodeSpaces(String path)

Encodes spaces in a path, replacing them by %20.

Parameters:

path - Path that may contain spaces

Returns:

The path with all spaces replaced by %20.

appendQueryParam

public static String appendQueryParam(String url,
                                      String queryParamName,
                                      String queryParamValue)

Appends a query parameter to an URL that may or may not contain query parameters already.

Parameters:

url - base URL to apply the new query parameter

queryParamName - query parameter name

queryParamValue - query parameter value

Returns:

a new string with the query parameter appended