Package lumis.portal.url

Class URLUtil

java.lang.Object

lumis.portal.url.URLUtil

public abstract class URLUtil
extends Object

Utility class for URL related actions.

Since:

8.1.0

Version:

$Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

Method Summary

Modifier and Type	Method	Description
static String	buildQueryString(Map<String,Collection<String>> values)	Returns a query string created with the given parameters.
static PageWebResource	getFirstPageWebResource(ChannelWebResource cwr)	Returns the page web resource for the first page whithin the channel of the given channel web resource.
static String	getHost(URI uri)	Returns the host of the given URI or null if none could be inferred.
static String	getQueryStringFromUri(String uri)	Given a URI, extract its query string.
static Map<String,Collection<String>>	getQueryStringParametersMap(String uri)	Returns the query string parameters map.
static String	getQueryStringParameterValue(String paramName, String uri)	Returns the first non-empty query string parameter value.
static Collection<String>	getQueryStringParameterValues(String paramName, String uri)	Returns the query string parameter values.
static String	getRefererPath(String referer, IWebsiteBaseURL baseURL, HttpServletRequest request)	Get the Web Resource path from the given URL
static String	getRefererRelativeUri(String referer, IWebsiteBaseURL baseURL, HttpServletRequest request)	Returns the URI relative to the application root, without the mode root path, including the query string.
static URI	removeDefaultPort(URI uri)	Remove default port of the given URI. It removes the port if: The scheme is http and the port is 80; or The scheme is https and the port is 443 If the given URI is not absolute, is opaque or doesn't fit the above rule, the original URI will be returned.

Methods inherited from class java.lang.Object

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

Method Detail

getRefererPath

public static String getRefererPath(String referer,
                                    IWebsiteBaseURL baseURL,
                                    HttpServletRequest request)

Get the Web Resource path from the given URL

Parameters:

referer - The URL to get the path from

baseURL - The WebsiteBaseURL

request - The HttpServletRequest

Returns:

A string corresponding to the web resource path of the URL

Since:

8.1.0

getRefererRelativeUri

public static String getRefererRelativeUri(String referer,
                                           IWebsiteBaseURL baseURL,
                                           HttpServletRequest request)

Returns the URI relative to the application root, without the mode root path, including the query string.

Parameters:

referer - The URL to get the path from

baseURL - The WebsiteBaseURL

request - The HttpServletRequest

Returns:

A string corresponding to the relative uri.

Since:

10.4.0

getFirstPageWebResource

public static PageWebResource getFirstPageWebResource(ChannelWebResource cwr)
                                               throws PortalException

Returns the page web resource for the first page whithin the channel of the given channel web resource.

This method requires a current session and a current transaction.

Parameters:

cwr - the channel web resource.

Returns:

the page web resource for the first page whithin the channel of the given channel web resource.

Throws:

PortalException

Since:

10.3.0

getHost

public static String getHost(URI uri)

Returns the host of the given URI or null if none could be inferred.

Parameters:

uri - the URI.

Returns:

the host of the given URI or null if none could be inferred.

Since:

10.3.0

removeDefaultPort

public static URI removeDefaultPort(URI uri)

Remove default port of the given URI.
It removes the port if:

• The scheme is http and the port is 80; or
• The scheme is https and the port is 443

If the given URI is not absolute, is opaque or doesn't fit the above rule, the original URI will be returned.

Parameters:

uri - the URI to have its default port removed.

Returns:

the given URI without the default port (if any).

Throws:

NullPointerException - if the given URI is null.

Since:

10.4.0

getQueryStringFromUri

public static String getQueryStringFromUri(String uri)

Given a URI, extract its query string.

Parameters:

uri - the URI

Returns:

the query string (or an empty string if there's no query string)

Since:

14.2.0

getQueryStringParametersMap

public static Map<String,Collection<String>> getQueryStringParametersMap(String uri)

Returns the query string parameters map.

Parameters:

uri - the URI

Returns:

the query string parameters map.

Since:

14.2.0

getQueryStringParameterValue

public static String getQueryStringParameterValue(String paramName,
                                                  String uri)

Returns the first non-empty query string parameter value.

Parameters:

paramName - the desired parameter name

uri - the URI

Returns:

the first non-empty query string parameter value.

Since:

14.2.0

getQueryStringParameterValues

public static Collection<String> getQueryStringParameterValues(String paramName,
                                                               String uri)

Returns the query string parameter values.

Parameters:

paramName - the parameter name

uri - the URI

Returns:

the query string parameter values.

Since:

14.2.0

buildQueryString

public static String buildQueryString(Map<String,Collection<String>> values)

Returns a query string created with the given parameters.

Parameters:

values - the parameter values

Returns:

a query string created with the given parameters.

Since:

14.2.0