com.github.dandelion.core.util

Class UrlUtils

java.lang.Object

com.github.dandelion.core.util.UrlUtils

public class UrlUtils
extends Object

Collection of utilities to ease working with URLs.

Since:

0.10.0

Author:

Thibault Duchateau

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORWARD_QUERY_STRING_ATTRIBUTE
static String	FORWARD_REQUEST_URI_ATTRIBUTE
static String	INCLUDE_REQUEST_URI_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
UrlUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addParameter(StringBuilder url, String name)
static void	addParameter(StringBuilder url, String name, Object value)
static boolean	containsParameter(javax.servlet.http.HttpServletRequest request, String parameterName)
static boolean	doesNotContainParamater(javax.servlet.http.HttpServletRequest request, String parameterName)
static String	getBaseUrl(javax.servlet.http.HttpServletRequest request) Returns the base URL, with the context path included by default.
static String	getBaseUrl(javax.servlet.http.HttpServletRequest request, boolean withContextPath) Returns the base URL, containing the context path or not depending on the withContextPath param.
static StringBuilder	getContext(javax.servlet.http.HttpServletRequest request)
static StringBuilder	getCurrentUri(javax.servlet.http.HttpServletRequest request) Get the current URI with potentiel request parameters.
static StringBuilder	getCurrentUrl(javax.servlet.http.HttpServletRequest request, boolean preserveParameters) Return the current URL, with or without query parameters, depending on the perserveParameters parameter.
static String	getProcessedUrl(StringBuilder url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static String	getProcessedUrl(String url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static boolean	isAbsolute(String url) Check whether the passed URL is absolute.
static boolean	isContextRelative(String url, javax.servlet.http.HttpServletRequest request)
static boolean	isProtocolRelative(String url)
static boolean	isServerRelative(String url)

Methods inherited from class java.lang.Object

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

Field Detail

FORWARD_REQUEST_URI_ATTRIBUTE

public static final String FORWARD_REQUEST_URI_ATTRIBUTE

See Also:

Constant Field Values

FORWARD_QUERY_STRING_ATTRIBUTE

public static final String FORWARD_QUERY_STRING_ATTRIBUTE

See Also:

Constant Field Values

INCLUDE_REQUEST_URI_ATTRIBUTE

public static final String INCLUDE_REQUEST_URI_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

UrlUtils

public UrlUtils()

Method Detail

getCurrentUri

public static StringBuilder getCurrentUri(javax.servlet.http.HttpServletRequest request)

Get the current URI with potentiel request parameters.

Parameters:

request - the request to extract the URI and parameters from

Returns:

the current URI.

getCurrentUrl

public static StringBuilder getCurrentUrl(javax.servlet.http.HttpServletRequest request,
                          boolean preserveParameters)

Return the current URL, with or without query parameters, depending on the perserveParameters parameter.

Parameters:

request - The current HttpServletRequest.

preserveParameters - preserve the url parameters.

Returns:

a String containing the current URL.

getProcessedUrl

public static String getProcessedUrl(String url,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)

getProcessedUrl

public static String getProcessedUrl(StringBuilder url,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)

isAbsolute

public static boolean isAbsolute(String url)

Check whether the passed URL is absolute.

isContextRelative

public static boolean isContextRelative(String url,
                        javax.servlet.http.HttpServletRequest request)

isServerRelative

public static boolean isServerRelative(String url)

isProtocolRelative

public static boolean isProtocolRelative(String url)

getContext

public static StringBuilder getContext(javax.servlet.http.HttpServletRequest request)

addParameter

public static void addParameter(StringBuilder url,
                String name)

addParameter

public static void addParameter(StringBuilder url,
                String name,
                Object value)

containsParameter

public static boolean containsParameter(javax.servlet.http.HttpServletRequest request,
                        String parameterName)

doesNotContainParamater

public static boolean doesNotContainParamater(javax.servlet.http.HttpServletRequest request,
                              String parameterName)

getBaseUrl

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

Returns the base URL, with the context path included by default.

For Example, for an URL like http://domain.com:port/context/foo/bar, this function returns http://domain.com:port/context.

Parameters:

request - The HttpServletRequest from which to extract the base URL.

Returns:

the base URL of the current request.

getBaseUrl

public static String getBaseUrl(javax.servlet.http.HttpServletRequest request,
                boolean withContextPath)

Returns the base URL, containing the context path or not depending on the withContextPath param.

For Example, for an URL like http://domain.com:port/context/foo/bar, this function returns http://domain.com:port/context.

Parameters:

request - The HttpServletRequest from which to extract the base URL.

withContextPath - true to include the context path, false otherwise.

Returns:

the base URL of the current request.