Object UrlUtils
-
- All Implemented Interfaces:
public class UrlUtils
-
-
Method Summary
Modifier and Type Method Description final static BooleanisInternal(String url)Test if the url is an internal URL. final static BooleanisNotInternal(String url)Test if the url is not an internal URL. final static URLgetURLOrNull(String spec)Creates a {@code URL} object from the {@code String} representation. final static BooleanisStandard(String str)Test if the str is a standard URL. final static URLnormalize(String url, Boolean ignoreQuery)Normalize a url spec. final static StringnormalizeOrEmpty(String url, Boolean ignoreQuery)Normalize a url spec. final static StringnormalizeOrNull(String url, Boolean ignoreQuery)Normalize a url spec. final static List<String>normalizeUrls(Iterable<String> urls, Boolean ignoreQuery)Normalize a url spec. final Map<String, String>splitQueryParameters(String url)Split the query parameters of a url. final StringgetQueryParameters(String url, String parameterName)Get the query parameter of a url. final StringremoveQueryParameters(String url, String parameterNames)Remove the query parameters of a url. final StringkeepQueryParameters(String url, String parameterNames)Keep the query parameters of a url, and remove the others. final static URLresolveURL(URL base, String targetUrl)Resolve relative URL-s and fix a java.net.URL error in handling of URLs with pure query targets. final static Pair<String, String>splitUrlArgs(String configuredUrl)Split url and args final static StringmergeUrlArgs(String url, String args)Merge url and args final static StringgetUrlWithoutParameters(String url)Get the url without parameters final static Pair<String, String>normalizedUrlAndKey(String originalUrl, Boolean norm)Returns the normalized url and key final static StringreverseUrl(String url)Reverses a url's domain. final static StringreverseUrl(URL url)Reverses a url's domain. final static StringreverseUrl(Integer tenantId, String unreversedUrl)Get the reversed and tenanted format of unreversedUrl, unreversedUrl can be both tenanted or not tenanted This method might change the tenant id of the original urlZero tenant id means no tenant final static StringreverseUrlOrEmpty(String url)Reverses a url's domain. final static StringreverseUrlOrNull(String url)Reverses a url's domain. final static StringunreverseUrl(String reversedUrl)Get the unreversed url of a reversed url. final static StringunreverseUrl(Integer tenantId, String reversedUrl)Get unreversed and tenanted url of reversedUrl, reversedUrl can be both tenanted or not tenanted, This method might change the tenant id of the original url final static StringunreverseUrlOrNull(String reversedUrl)Get the unreversed url of a reversed url. final static StringgetStartKey(Integer tenantId, String unreversedUrl)Get start key for tenanted table final static StringgetStartKey(String unreversedUrl)Get start key for non-tenanted table final static StringgetEndKey(String unreversedUrl)Get end key for non-tenanted tables final static StringgetEndKey(Integer tenantId, String unreversedUrl)Get end key for tenanted tables final static StringdecodeKeyLowerBound(String startKey)We use unicode character \u0001 to be the lower key bound, but the client usally encode the character to be a string "\\u0001" or "\\\\u0001", so we should decode them to be the right oneNote, the character is displayed as <U></U>+0001> in some output systemNow, we consider all the three character/string \u0001, "\\u0001", "\\\\u0001" are the lower key bound final static StringdecodeKeyUpperBound(String endKey)We use unicode character \uFFFF to be the upper key bound, but the client usally encode the character to be a string "\\uFFFF" or "\\\\uFFFF", so we should decode them to be the right oneNote, the character may display as <U></U>+FFFF> in some output systemNow, we consider all the three character/string \uFFFF, "\\uFFFF", "\\\\uFFFF" are the upper key bound final static StringgetReversedHost(String reversedUrl)Given a reversed url, returns the reversed host E.g "com.foo.bar:http:8983/to/index.html? final static StringreverseHost(String hostName)Reverse the host name. final static StringunreverseHost(String reversedHostName)Unreverse the host name. -
-
Method Detail
-
isInternal
final static Boolean isInternal(String url)
Test if the url is an internal URL. Internal URLs are URLs that are used to identify internal resources and will never be fetched from the internet.
- Parameters:
url- The url to test- Returns:
true if the given str is an internal URL, false otherwise
-
isNotInternal
final static Boolean isNotInternal(String url)
Test if the url is not an internal URL. Internal URLs are URLs that are used to identify internal resources and will never be fetched from the internet.
- Parameters:
url- The url to test- Returns:
true if the given str is not an internal URL, false otherwise
-
getURLOrNull
final static URL getURLOrNull(String spec)
Creates a {@code URL} object from the {@code String} representation.
- Parameters:
spec- the {@code String} to parse as a URL.- Returns:
the URL parsed from spec, or null if no protocol is specified, or an unknown protocol is found, or {@code spec} is {@code null}, or the parsed URL fails to comply with the specific syntax of the associated protocol.
-
isStandard
final static Boolean isStandard(String str)
Test if the str is a standard URL.
- Parameters:
str- The string to test- Returns:
true if the given str is a a standard URL, false otherwise
-
normalize
final static URL normalize(String url, Boolean ignoreQuery)
Normalize a url spec.
A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example: http://java.sun.com/index.html#chapter1
The fragment will be removed after the normalization. If ignoreQuery is true, the query string will be removed.
- Parameters:
url-The url to normalize, a tailing argument list is allowed and will be removedignoreQuery-If true, the result url does not contain a query string- Returns:
The normalized URL
-
normalizeOrEmpty
final static String normalizeOrEmpty(String url, Boolean ignoreQuery)
Normalize a url spec.
A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example: http://java.sun.com/index.html#chapter1
The fragment will be removed after the normalization. If ignoreQuery is true, the query string will be removed.
- Parameters:
url-The url to normalize, a tailing argument list is allowed and will be removedignoreQuery-If true, the result url does not contain a query string- Returns:
The normalized url, or an empty string ("") if the given string violates RFC 2396
-
normalizeOrNull
final static String normalizeOrNull(String url, Boolean ignoreQuery)
Normalize a url spec.
A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example: http://java.sun.com/index.html#chapter1
The fragment will be removed after the normalization. If ignoreQuery is true, the query string will be removed.
- Parameters:
url-The url to normalize, a tailing argument list is allowed and will be removedignoreQuery-If true, the result url does not contain a query string- Returns:
The normalized url, or null if the given string violates RFC 2396
-
normalizeUrls
final static List<String> normalizeUrls(Iterable<String> urls, Boolean ignoreQuery)
Normalize a url spec.
A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example: http://java.sun.com/index.html#chapter1
The fragment will be removed after the normalization. If ignoreQuery is true, the query string will be removed.
- Parameters:
urls-The urls to normalize, a tailing argument list is allowed and will be removedignoreQuery-If true, the result url does not contain a query string- Returns:
The normalized URLs
-
splitQueryParameters
final Map<String, String> splitQueryParameters(String url)
Split the query parameters of a url.
- Parameters:
url- The url to split- Returns:
The query parameters of the url
-
getQueryParameters
final String getQueryParameters(String url, String parameterName)
Get the query parameter of a url.
- Parameters:
url- The url to splitparameterName- The name of the query parameter- Returns:
The query parameter of the url
-
removeQueryParameters
final String removeQueryParameters(String url, String parameterNames)
Remove the query parameters of a url.
- Parameters:
url- The url to splitparameterNames- The names of the query parameters- Returns:
The url without the query parameters
-
keepQueryParameters
final String keepQueryParameters(String url, String parameterNames)
Keep the query parameters of a url, and remove the others.
- Parameters:
url- The url to splitparameterNames- The names of the query parameters- Returns:
The url with only the query parameters
-
resolveURL
final static URL resolveURL(URL base, String targetUrl)
Resolve relative URL-s and fix a java.net.URL error in handling of URLs with pure query targets.
- Parameters:
base- base url- Returns:
resolved absolute url.
-
splitUrlArgs
final static Pair<String, String> splitUrlArgs(String configuredUrl)
Split url and args
- Parameters:
configuredUrl- url and args in$url $argsformat- Returns:
url and args pair
-
mergeUrlArgs
final static String mergeUrlArgs(String url, String args)
Merge url and args
- Parameters:
url- urlargs- args- Returns:
url and args in
$url $argsformat
-
getUrlWithoutParameters
final static String getUrlWithoutParameters(String url)
Get the url without parameters
- Parameters:
url- url- Returns:
url without parameters
-
normalizedUrlAndKey
final static Pair<String, String> normalizedUrlAndKey(String originalUrl, Boolean norm)
Returns the normalized url and key
- Returns:
normalized url and key
-
reverseUrl
final static String reverseUrl(String url)
Reverses a url's domain. This form is better for storing in hbase. Because scans within the same domain are faster.
E.g. "http://bar.foo.com:8983/to/index.html?a=b" becomes "com.foo.bar:8983:http/to/index.html?a=b".
- Parameters:
url- url to be reversed- Returns:
Reversed url
-
reverseUrl
final static String reverseUrl(URL url)
Reverses a url's domain. This form is better for storing in hbase. Because scans within the same domain are faster.
E.g. "http://bar.foo.com:8983/to/index.html?a=b" becomes "com.foo.bar:http:8983/to/index.html?a=b".
- Parameters:
url- url to be reversed- Returns:
Reversed url
-
reverseUrl
final static String reverseUrl(Integer tenantId, String unreversedUrl)
Get the reversed and tenanted format of unreversedUrl, unreversedUrl can be both tenanted or not tenanted This method might change the tenant id of the original url
Zero tenant id means no tenant
- Parameters:
unreversedUrl- the unreversed url, can be both tenanted or not tenanted- Returns:
the tenanted and reversed url of unreversedUrl
-
reverseUrlOrEmpty
final static String reverseUrlOrEmpty(String url)
Reverses a url's domain. This form is better for storing in hbase. Because scans within the same domain are faster.
E.g. "http://bar.foo.com:8983/to/index.html?a=b" becomes "com.foo.bar:8983:http/to/index.html?a=b".
- Parameters:
url- url to be reversed- Returns:
Reversed url or empty string if the url is invalid
-
reverseUrlOrNull
final static String reverseUrlOrNull(String url)
Reverses a url's domain. This form is better for storing in hbase. Because scans within the same domain are faster.
E.g. "http://bar.foo.com:8983/to/index.html?a=b" becomes "com.foo.bar:8983:http/to/index.html?a=b".
- Parameters:
url- url to be reversed- Returns:
Reversed url or null if the url is invalid
-
unreverseUrl
final static String unreverseUrl(String reversedUrl)
Get the unreversed url of a reversed url.
- Returns:
the unreversed url of reversedUrl
-
unreverseUrl
final static String unreverseUrl(Integer tenantId, String reversedUrl)
Get unreversed and tenanted url of reversedUrl, reversedUrl can be both tenanted or not tenanted, This method might change the tenant id of the original url
- Parameters:
tenantId- the expected tenant id of the reversedUrlreversedUrl- the reversed url, can be both tenanted or not tenanted- Returns:
the unreversed url of reversedTenantedUrl
-
unreverseUrlOrNull
final static String unreverseUrlOrNull(String reversedUrl)
Get the unreversed url of a reversed url.
- Returns:
the unreversed url of reversedUrl or null if the url is invalid
-
getStartKey
final static String getStartKey(Integer tenantId, String unreversedUrl)
Get start key for tenanted table
- Parameters:
unreversedUrl- unreversed key, which is the original url- Returns:
reverse and tenanted key
-
getStartKey
final static String getStartKey(String unreversedUrl)
Get start key for non-tenanted table
- Parameters:
unreversedUrl- unreversed key, which is the original url- Returns:
reverse key
-
getEndKey
final static String getEndKey(String unreversedUrl)
Get end key for non-tenanted tables
- Parameters:
unreversedUrl- unreversed key, which is the original url- Returns:
reverse, key bound decoded key
-
getEndKey
final static String getEndKey(Integer tenantId, String unreversedUrl)
Get end key for tenanted tables
- Parameters:
unreversedUrl- unreversed key, which is the original url- Returns:
reverse, tenanted and key bound decoded key
-
decodeKeyLowerBound
final static String decodeKeyLowerBound(String startKey)
We use unicode character \u0001 to be the lower key bound, but the client usally encode the character to be a string "\\u0001" or "\\\\u0001", so we should decode them to be the right one
Note, the character is displayed as <U></U>+0001> in some output system
Now, we consider all the three character/string \u0001, "\\u0001", "\\\\u0001" are the lower key bound
-
decodeKeyUpperBound
final static String decodeKeyUpperBound(String endKey)
We use unicode character \uFFFF to be the upper key bound, but the client usally encode the character to be a string "\\uFFFF" or "\\\\uFFFF", so we should decode them to be the right one
Note, the character may display as <U></U>+FFFF> in some output system
Now, we consider all the three character/string \uFFFF, "\\uFFFF", "\\\\uFFFF" are the upper key bound
-
getReversedHost
final static String getReversedHost(String reversedUrl)
Given a reversed url, returns the reversed host E.g "com.foo.bar:http:8983/to/index.html?a=b" -> "com.foo.bar"
- Parameters:
reversedUrl- Reversed url- Returns:
Reversed host
-
reverseHost
final static String reverseHost(String hostName)
Reverse the host name.
- Parameters:
hostName- host name- Returns:
reversed host name
-
unreverseHost
final static String unreverseHost(String reversedHostName)
Unreverse the host name.
- Parameters:
reversedHostName- reversed host name- Returns:
host name
-
-
-
-