org.esigate.util

Class UriUtils

java.lang.Object

org.esigate.util.UriUtils

public final class UriUtils
extends Object

Utility class to manipulate URI represented as a String or as a URI.

Author:

Francois-Xavier Bonnet

Method Summary

Modifier and Type	Method and Description
static URI	concatPath(URI base, String relPath) Concatenates 2 URI by taking the beginning of the first (up to the path) and the end of the other (starting from the path).
static URI	createURI(String uri) Creates an URI after escaping some special characters in order to tolerate some incorrect URI types.
static String	createURI(String scheme, String host, int port, String path, String query, String fragment) Creates an URI as a String.
static String	encodeIllegalCharacters(String uri) Fixes common mistakes in URI by replacing all illegal characters by their encoded value.
static org.apache.http.HttpHost	extractHost(String uri) Extracts the HttpHost from a URI.
static org.apache.http.HttpHost	extractHost(URI uri) Extracts the HttpHost from a URI.
static String	extractHostName(String uri) Extracts the host name from a URI.
static String	extractScheme(String uri) Extracts the scheme of a URI.
static String	getPath(String uri) Returns the decoded path component of this URI.
static String	getRawQuery(String uri) Returns the raw query component of this URI.
static boolean	isAbsolute(String uri) Checks if a URI starts with a protocol.
static List<org.apache.http.NameValuePair>	parse(String uri, String charset) Returns a list of NameValuePairs as built from the URI's query portion.
static String	removeQuerystring(String uriString) Removes the query and fragment at the end of a URI.
static URI	removeServer(URI uri) Removes the server information frome a URI.
static String	removeSessionId(String sessionId, String page) Removes the jsessionid that may have been added to a URI on a java application server.
static URI	resolve(String relUri, URI base) Interpret the url relatively to the request url (may be relative).
static String	rewriteURI(String uri, org.apache.http.HttpHost targetHost) Replaces the scheme, host and port in a URI.

Methods inherited from class java.lang.Object

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

Method Detail

encodeIllegalCharacters

public static String encodeIllegalCharacters(String uri)

Fixes common mistakes in URI by replacing all illegal characters by their encoded value.

Parameters:

uri - the URI to fix

Returns:

the fixed URI

createURI

public static String createURI(String scheme,
                               String host,
                               int port,
                               String path,
                               String query,
                               String fragment)

Creates an URI as a String.

Parameters:

scheme - the scheme

host - the host

port - the port

path - the path

query - the query

fragment - the fragment

Returns:

the uri

extractHostName

public static String extractHostName(String uri)

Extracts the host name from a URI.

Parameters:

uri - the uri

Returns:

the host name

extractHost

public static org.apache.http.HttpHost extractHost(String uri)

Extracts the HttpHost from a URI.

Parameters:

uri - the URI

Returns:

the HttpHost

extractHost

public static org.apache.http.HttpHost extractHost(URI uri)

Extracts the HttpHost from a URI.

Parameters:

uri - the URI

Returns:

the HttpHost

createURI

public static URI createURI(String uri)

Creates an URI after escaping some special characters in order to tolerate some incorrect URI types. If the uri contains a server name but no path, the path is set to "/" as a browser would do.

Parameters:

uri - the URI as a String

Returns:

the URI as a URI object

rewriteURI

public static String rewriteURI(String uri,
                                org.apache.http.HttpHost targetHost)

Replaces the scheme, host and port in a URI.

Parameters:

uri - the URI

targetHost - the target host

Returns:

the rewritten URI

removeSessionId

public static String removeSessionId(String sessionId,
                                     String page)

Removes the jsessionid that may have been added to a URI on a java application server.

Parameters:

sessionId - the value of the sessionId that can also be found in a JSESSIONID cookie

page - the html code of the page

Returns:

the fixed html

extractScheme

public static String extractScheme(String uri)

Extracts the scheme of a URI.

Parameters:

uri - the URI

Returns:

the scheme

getRawQuery

public static String getRawQuery(String uri)

Returns the raw query component of this URI. The query component of a URI, if defined, only contains legal URI characters.

Parameters:

uri - the URI

Returns:

The raw query component of this URI, or null if the query is undefined

getPath

public static String getPath(String uri)

Returns the decoded path component of this URI. The string returned by this method is equal to that returned by the getRawPath method except that all sequences of escaped octets are decoded.

Parameters:

uri - the uri to retrieve the path from

Returns:

The decoded path component of this URI, or null if the path is undefined

parse

public static List<org.apache.http.NameValuePair> parse(String uri,
                                                        String charset)

Returns a list of NameValuePairs as built from the URI's query portion. For example, a URI of http://example.org/path/to/file?a=1&b=2&c=3 would return a list of three NameValuePairs, one for a=1, one for b=2, and one for c=3. By convention, '&' and ';' are accepted as parameter separators.

This is typically useful while parsing an HTTP PUT. This API is currently only used for testing.

Parameters:

uri - URI to parse

charset - Charset name to use while parsing the query

Returns:

a list of NameValuePair as built from the URI's query portion.

isAbsolute

public static boolean isAbsolute(String uri)

Checks if a URI starts with a protocol.

Parameters:

uri - the URI

Returns:

true if the URI starts with "http://" or "https://"

concatPath

public static URI concatPath(URI base,
                             String relPath)

Concatenates 2 URI by taking the beginning of the first (up to the path) and the end of the other (starting from the path). While concatenating, checks that there is no doubled "/" character between the path fragments.

Parameters:

base - the base uri

relPath - the path to concatenate with the base uri

Returns:

the concatenated uri

removeServer

public static URI removeServer(URI uri)

Removes the server information frome a URI.

Parameters:

uri - the URI

Returns:

a new URI with no scheme, host and port

resolve

public static URI resolve(String relUri,
                          URI base)

Interpret the url relatively to the request url (may be relative). Due to a bug in URI class when using a relUri containing only a query string, we cannot use directly the method provided by URI class.

Parameters:

relUri - the relative URI

base - the reference URI

Returns:

the resolved URI

removeQuerystring

public static String removeQuerystring(String uriString)

Removes the query and fragment at the end of a URI.

Parameters:

uriString - the original URI as a String

Returns:

the URI without querystring nor fragment