org.gatein.common.net

Class URLTools

java.lang.Object

org.gatein.common.net.URLTools

public class URLTools
extends Object

Since:

2.4 (May 26, 2009)

Version:

$Revision: 7686 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	URLTools.PortReplacementGenerator
static class	URLTools.URLMatch
static class	URLTools.URLReplacementGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_PREFIX
static String	FTP_PREFIX
static String	HTTP_PREFIX
static String	HTTPS_PREFIX
static String	PORT_END
static String	RE_EMAIL_VALIDATION
static String	SCH_END
static String	SLASH

Constructor Summary

Constructors

Constructor and Description
URLTools()

Method Summary

Methods

Modifier and Type	Method and Description
static String	decodeXWWWFormURL(String s)
static String	encodeXWWWFormURL(String s)
static void	enforceAbsoluteURL(String url) Enforces that the given URL is absolute
static boolean	exists(String stringURL, boolean allowNull) to remove : an API should not try to accomodate the client for that kind of situation, why not also something like forbidStringLengthToDivisibleBy3 ?
static boolean	exists(URL url) Determines that the specified URL corresponds to an existing resource by trying to open a stream from it.
static boolean	exists(URL url, long waitForMillis) Determines if the specified URL corresponds to an existing resource by trying to open a stream from it.
static URLTools.URLMatch[]	extractURLsFrom(String markup)
static byte[]	getContent(URL url, int soTimeoutMillis, int connTimeoutMillis) Fetches content from of the URL as a byte array or null if a problem occurred.
static InputStream	getContentAsInputStream(URL url, int soTimeoutMillis, int connTimeoutMillis) Fetches content from URL as an InputStream.
static String	getFileExtensionOrNullFrom(URL url)
static String	getServerAddressFrom(javax.servlet.http.HttpServletRequest request) Returns the server address that originated the request, without final /.
static int	getURLCountIn(String markup)
static boolean	isEmailValid(String address) Return true is the address is not null and matches the email validation regular expression.
static boolean	isNetworkURL(String url)
static boolean	isURLAbsolute(String url)
static String	replaceServerPortInURL(String url, int newPort)
static String	replaceURLsBy(String markup, String[] replacements)
static String	replaceURLsBy(String markup, URLTools.URLReplacementGenerator generator)
static String	safeDecodeForHTMLId(String value)
static String	safeEncodeForHTMLId(String value)

Methods inherited from class java.lang.Object

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

Field Detail

RE_EMAIL_VALIDATION

public static final String RE_EMAIL_VALIDATION

See Also:

Constant Field Values

HTTP_PREFIX

public static final String HTTP_PREFIX

See Also:

Constant Field Values

HTTPS_PREFIX

public static final String HTTPS_PREFIX

See Also:

Constant Field Values

FTP_PREFIX

public static final String FTP_PREFIX

See Also:

Constant Field Values

FILE_PREFIX

public static final String FILE_PREFIX

See Also:

Constant Field Values

SCH_END

public static final String SCH_END

See Also:

Constant Field Values

PORT_END

public static final String PORT_END

See Also:

Constant Field Values

SLASH

public static final String SLASH

See Also:

Constant Field Values

Constructor Detail

URLTools

public URLTools()

Method Detail

isURLAbsolute

public static boolean isURLAbsolute(String url)

getServerAddressFrom

public static String getServerAddressFrom(javax.servlet.http.HttpServletRequest request)

Returns the server address that originated the request, without final /.

Parameters:

request -

Returns:

getFileExtensionOrNullFrom

public static String getFileExtensionOrNullFrom(URL url)

getContent

public static byte[] getContent(URL url,
                int soTimeoutMillis,
                int connTimeoutMillis)
                         throws IllegalArgumentException

Fetches content from of the URL as a byte array or null if a problem occurred. The timeout values must not be negative integers, when it is equals to zero it means that it does not setup a timeout and use the default values.

Parameters:

url - the URL the URL of the resource

soTimeoutMillis - the socket connection timeout in millis

connTimeoutMillis - the connection timeout in millis

Returns:

the retrieved byte array

Throws:

IllegalArgumentException - if the URL is null or any time out value is negative

getContentAsInputStream

public static InputStream getContentAsInputStream(URL url,
                                  int soTimeoutMillis,
                                  int connTimeoutMillis)
                                           throws IOException

Fetches content from URL as an InputStream. The timeout values must not be negative integers, when it is equals to zero it means that it does not setup a timeout and use the default values.

Parameters:

url - the URL the URL of the resource

soTimeoutMillis - the socket connection timeout in millis

connTimeoutMillis - the connection timeout in millis

Returns:

the buffered content for the URL

Throws:

IllegalArgumentException - if the URL is null or any time out value is negative

IOException

Since:

1.1

isNetworkURL

public static boolean isNetworkURL(String url)

Parameters:

url -

Returns:

Since:

2.4.2

enforceAbsoluteURL

public static void enforceAbsoluteURL(String url)
                               throws IllegalArgumentException

Enforces that the given URL is absolute

Parameters:

url - the String representation of the URL to be checked

Throws:

IllegalArgumentException - if the given URL is not absolute

encodeXWWWFormURL

public static String encodeXWWWFormURL(String s)

decodeXWWWFormURL

public static String decodeXWWWFormURL(String s)

isEmailValid

public static boolean isEmailValid(String address)

Return true is the address is not null and matches the email validation regular expression.

exists

public static boolean exists(URL url)

Determines that the specified URL corresponds to an existing resource by trying to open a stream from it. Same as exists(url, 1000)

Parameters:

url -

Returns:

exists

public static boolean exists(URL url,
             long waitForMillis)
                      throws IllegalArgumentException

Determines if the specified URL corresponds to an existing resource by trying to open a stream from it.

Parameters:

url - the URL to be tested

waitForMillis - the number of milliseconds to wait before timing out, 0 meaning never timing out.

Returns:

Throws:

IllegalArgumentException - if the url is null or the time out negative

Since:

2.4.2

exists

public static boolean exists(String stringURL,
             boolean allowNull)

to remove : an API should not try to accomodate the client for that kind of situation, why not also something like forbidStringLengthToDivisibleBy3 ?

Parameters:

stringURL -

allowNull - true if passing null will be ignored and just return false, false to throw an IllegalArgumentException is the given URL is null.

Returns:

Since:

2.4.2

extractURLsFrom

public static URLTools.URLMatch[] extractURLsFrom(String markup)

getURLCountIn

public static int getURLCountIn(String markup)

replaceURLsBy

public static String replaceURLsBy(String markup,
                   String[] replacements)

replaceURLsBy

public static String replaceURLsBy(String markup,
                   URLTools.URLReplacementGenerator generator)

replaceServerPortInURL

public static String replaceServerPortInURL(String url,
                            int newPort)

Parameters:

url -

newPort -

Returns:

Since:

2.4.2

safeEncodeForHTMLId

public static String safeEncodeForHTMLId(String value)

safeDecodeForHTMLId

public static String safeDecodeForHTMLId(String value)