com.communote.common.util

Class UrlHelper

java.lang.Object

com.communote.common.util.UrlHelper

public class UrlHelper
extends Object

Helper class for working with URLs.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	URL_PATTERN Pattern for recognition of URLs.

Method Summary

Modifier and Type	Method and Description
static void	assertIsValidUrl(String url) Checks if url is well formed.
static String	convertAnchorsToString(String content) Parses a string for HTML anchor elements and replaces a shortened URL (suffixed by ...) within the the anchor with the href value.
static String	getProtocolHostPort(String url, boolean stripUserInfo) Get a substring of an absolute URL from beginning up to the path, excluding the path and without a trailing slash.
static String	insertSessionIdInUrl(String url, String sessionId) Insert the session ID in the URL in the form ";jessionid=SESSION_ID".
static boolean	isAbsoluteHttpUrl(String url) Test whether the given URL is an absolute URL using the HTTP or HTTPS protocol.
static boolean	isAbsoluteUrl(String url) Test whether the provided URL is absolute.
static String	shortenUrl(String protocolHostPart, String pathPart, String queryPart, String fragmentIdentifier) Shortens a URL.
static String	urlEncodeUrlPath(String path) URL encode (application/x-www-form-urlencoded format) the path component of a URL.

Methods inherited from class java.lang.Object

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

Field Detail

URL_PATTERN

public static final Pattern URL_PATTERN

Pattern for recognition of URLs. The pattern tries to find URLs as defined in RFC2396. However there are some differences

• The protocol is limited to HTTP, HTTPS, FTP and FTPS
• The protocol can be omitted if URL starts with www. and will then default to HTTP
• The domain can contain any unicode character of class letter and not just a-z
• The path component can contain any unicode character of class letter and not just a-z
• The path component can only contain one segment

Method Detail

assertIsValidUrl

public static void assertIsValidUrl(String url)

Checks if url is well formed. If not an IllegalArgumentException is thrown

Parameters:

url - the url to check

convertAnchorsToString

public static String convertAnchorsToString(String content)

Parses a string for HTML anchor elements and replaces a shortened URL (suffixed by ...) within the the anchor with the href value. If the anchor does not contain any URL the href value is appended to the anchor content (encapsulated by parentheses). The anchor tag and attributes will be removed.

Parameters:

content - the content to parse

Returns:

the processed content

getProtocolHostPort

public static String getProtocolHostPort(String url,
                                         boolean stripUserInfo)

Get a substring of an absolute URL from beginning up to the path, excluding the path and without a trailing slash.

Parameters:

url - the absolute URL to process

stripUserInfo - whether to remove the user info if contained

Returns:

the substring or null if the provided URL is not absolute, has an unsupported protocol or no host.

insertSessionIdInUrl

public static String insertSessionIdInUrl(String url,
                                          String sessionId)

Insert the session ID in the URL in the form ";jessionid=SESSION_ID". Takes care of query strings.

Parameters:

url - the url to modify

sessionId - the sessionId to insert

Returns:

the url/uri with the session id

isAbsoluteHttpUrl

public static boolean isAbsoluteHttpUrl(String url)

Test whether the given URL is an absolute URL using the HTTP or HTTPS protocol.

Parameters:

url - the URL to check

Returns:

true if the URL is not null and absolute

isAbsoluteUrl

public static boolean isAbsoluteUrl(String url)

Test whether the provided URL is absolute.

Parameters:

url - the URL to test

Returns:

true if the URL starts with a scheme name as defined in RFC 1738

shortenUrl

public static String shortenUrl(String protocolHostPart,
                                String pathPart,
                                String queryPart,
                                String fragmentIdentifier)

Shortens a URL.

Parameters:

protocolHostPart - the protocol and host part of the URL including the port

pathPart - the path part of the URL; can be null

queryPart - the query part of the URL; can be null

fragmentIdentifier - the fragment identifier of the URL; can be null

Returns:

the shortened URL

urlEncodeUrlPath

public static String urlEncodeUrlPath(String path)

URL encode (application/x-www-form-urlencoded format) the path component of a URL. The method uses the UTF-8 encoding scheme.

Note: the application/x-www-form-urlencoded format encodes spaces with the plus character. For proper URI encoding better use UriUtils.encodeUriComponent(String)!

Parameters:

path - the path component of a URL. If parts of the path are already URL encoded these will be omitted

Returns:

the encoded path component