com.dkfqs.tools.lib

Class ParseURL

java.lang.Object

com.dkfqs.tools.lib.ParseURL

public class ParseURL
extends java.lang.Object

Parse an URL into parts.

Default TCP/IP ports are supported for the following protocols:

• http
• https
• ws
• wss

Constructor Summary

Constructors

Constructor and Description
ParseURL(java.lang.String url) Create a new instance and parse the URL.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	decodeValue(java.lang.String encodedValue) Convert a percent-encoded/URL-encoded value to a plain value by applying the UTF-8 charset.
static java.lang.String	encodeValue(java.lang.String plainText) Convert a plain value to a percent-encoded/URL-encoded value by applying the UTF-8 charset.
static java.lang.String	escapedTextToPlainText(java.lang.String escapedText) Convert an escaped text of a URL query string name or value parameter to plain text.
java.lang.String	getFragmentIdentifier() Get the fragment identifier (the text after the '#' anchor).
java.lang.String	getHost() Get the host.
java.lang.String	getPath() Get the path, without (optional) CGI parameters, and without the (optional) fragment identifier.
int	getPort() Get the IP port, or - if the URL contains no IP port - get the default IP port of the protocol.
java.lang.String	getProtocol() Get the protocol.
java.lang.String	getRawCGIParams() Get the raw CGI parameters.
java.lang.String	getRawPath() Get the raw path, inclusive (optional) CGI parameters, but without the (optional) fragment identifier.
int	getRawPort() Get the raw IP port of the URL.
static java.lang.String	getUrlQueryString(java.lang.String url) Get the query string of an URL.
static java.util.ArrayList<KeyValuePair<java.lang.String,java.lang.String>>	getUrlQueryStringNameValuePairs(java.lang.String queryString) Get an array list of name/value pairs from an URL query string.
boolean	hasNoPath() Get if the URL has no path.
static java.lang.String	plainTextToEscapedText(java.lang.String plainText) Convert a plain text of a URL query string name or value parameter to escaped text.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseURL

public ParseURL(java.lang.String url)
         throws java.net.MalformedURLException

Create a new instance and parse the URL.

Parameters:

url - the URL to parse

Throws:

java.net.MalformedURLException - if parsing fails

Method Detail

getProtocol

public java.lang.String getProtocol()

Get the protocol.

Returns:

the protocol (always in lowercase)

getHost

public java.lang.String getHost()

Get the host.

Returns:

the host

getRawPort

public int getRawPort()

Get the raw IP port of the URL.

Returns:

the raw IP port of the URL, or -1 if the URL contains no IP port.

getPort

public int getPort()

Get the IP port, or - if the URL contains no IP port - get the default IP port of the protocol.

Returns:

the IP port, or -1 if no such information is available

hasNoPath

public boolean hasNoPath()

Get if the URL has no path.

Returns:

true if the URL has no path

getRawPath

public java.lang.String getRawPath()

Get the raw path, inclusive (optional) CGI parameters, but without the (optional) fragment identifier. Note that this method does not unescape any chars.

Returns:

the raw path, inclusive (optional) CGI parameters, but without the (optional) fragment identifier. If the URL contains no path then '/' is returned.

getPath

public java.lang.String getPath()

Get the path, without (optional) CGI parameters, and without the (optional) fragment identifier. Note that this method does not unescape any chars.

Returns:

the path, without (optional) CGI parameters, and without the (optional) fragment identifier

getRawCGIParams

public java.lang.String getRawCGIParams()

Get the raw CGI parameters. Note that this method does not unescape any chars.

Returns:

the raw CGI parameters without the starting '?' char, or an empty string if the URL contains no CGI parameters

getFragmentIdentifier

public java.lang.String getFragmentIdentifier()

Get the fragment identifier (the text after the '#' anchor). Note that this method does not unescape any chars.

Returns:

the fragment identifier, or an empty string if the URL contains no fragment identifier

getUrlQueryString

public static java.lang.String getUrlQueryString(java.lang.String url)

Get the query string of an URL.

Parameters:

url - the URL, or the full path of an URL

Returns:

the query string of the URL, or an empty string if the URL contains no query string

getUrlQueryStringNameValuePairs

public static java.util.ArrayList<KeyValuePair<java.lang.String,java.lang.String>> getUrlQueryStringNameValuePairs(java.lang.String queryString)

Get an array list of name/value pairs from an URL query string.

Parameters:

queryString - the URL query string

Returns:

an array list of name/value pairs

escapedTextToPlainText

public static java.lang.String escapedTextToPlainText(java.lang.String escapedText)

Convert an escaped text of a URL query string name or value parameter to plain text.

Parameters:

escapedText - the escaped text

Returns:

the plain text, or null if the escaped text is invalid and cannot converted

plainTextToEscapedText

public static java.lang.String plainTextToEscapedText(java.lang.String plainText)

Convert a plain text of a URL query string name or value parameter to escaped text. Note: You cannot convert a full query string in one step with this method, which means that each name and each value must be converted separately.

Parameters:

plainText - the plain text

Returns:

the escaped text

encodeValue

public static java.lang.String encodeValue(java.lang.String plainText)
                                    throws java.io.UnsupportedEncodingException

Convert a plain value to a percent-encoded/URL-encoded value by applying the UTF-8 charset.

Parameters:

plainText - the plain text

Returns:

the percent-encoded/URL-encoded value

Throws:

java.io.UnsupportedEncodingException - if the encoding fails

decodeValue

public static java.lang.String decodeValue(java.lang.String encodedValue)
                                    throws java.io.UnsupportedEncodingException

Convert a percent-encoded/URL-encoded value to a plain value by applying the UTF-8 charset.

Parameters:

encodedValue - the percent-encoded/URL-encoded value

Returns:

the plain text

Throws:

java.io.UnsupportedEncodingException - if decoding encoding fails