com.aoindustries.net

Class UrlUtils

java.lang.Object

com.aoindustries.net.UrlUtils

public class UrlUtils
extends Object

Encoding helper utilities.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method and Description
static String	buildUrl(JspContext jspContext, String src, HttpParameters params, boolean srcAbsolute, LastModifiedServlet.AddLastModifiedWhen addLastModified)
static String	buildUrl(PageContext pageContext, String href, HttpParameters params, boolean hrefAbsolute, LastModifiedServlet.AddLastModifiedWhen addLastModified)
static String	buildUrl(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, String href, HttpParameters params, boolean hrefAbsolute, LastModifiedServlet.AddLastModifiedWhen addLastModified) Performs all the proper URL conversions along with optionally adding a lastModified parameter.
static String	decodeUrlPath(String href, String encoding) Decodes the URL up to the first ?, if present.
static String	encodeUrlPath(String href, String encoding) Encodes the characters in the URL up to trailing '?' or '#' (the first found of the two), not including any characters defined in RFC 3986: Reserved Characters.
static String	getScheme(String href) Gets the scheme for a URL, or null when no scheme found.
static boolean	isScheme(String href, String scheme) Checks if a URL starts with the given scheme.

Methods inherited from class java.lang.Object

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

Method Detail

isScheme

public static boolean isScheme(String href,
                               String scheme)

Checks if a URL starts with the given scheme.

Parameters:

scheme - The scheme to look for, not including colon. For example "http".

getScheme

public static final String getScheme(String href)

Gets the scheme for a URL, or null when no scheme found. The scheme must start the URL, and contain only (A-Z, a-z) before the first colon (:) found. The scheme is normalized to lower-case. An empty scheme will not be returned.

Returns:

The scheme, not including colon, or null when not found. For example "http".

encodeUrlPath

public static String encodeUrlPath(String href,
                                   String encoding)
                            throws UnsupportedEncodingException

Encodes the characters in the URL up to trailing '?' or '#' (the first found of the two), not including any characters defined in RFC 3986: Reserved Characters. To avoid ambiguity, parameters and anchors must have been correctly encoded by the caller.

Additionally, for tel: (case-insensitive) urls, replaces spaces (and non-breaking spaces) with hyphens.

Throws:

UnsupportedEncodingException

See Also:

decodeUrlPath(java.lang.String, java.lang.String)

decodeUrlPath

public static String decodeUrlPath(String href,
                                   String encoding)
                            throws UnsupportedEncodingException

Decodes the URL up to the first ?, if present. Does not decode any characters defined in RFC 3986: Reserved Characters.

Characters that are percent-decoded into a reserve character are left percent-encoded to avoid ambiguity.

Throws:

UnsupportedEncodingException

See Also:

encodeUrlPath(java.lang.String, java.lang.String)

buildUrl

public static String buildUrl(ServletContext servletContext,
                              HttpServletRequest request,
                              HttpServletResponse response,
                              String href,
                              HttpParameters params,
                              boolean hrefAbsolute,
                              LastModifiedServlet.AddLastModifiedWhen addLastModified)
                       throws MalformedURLException,
                              UnsupportedEncodingException

Performs all the proper URL conversions along with optionally adding a lastModified parameter. This includes:

1. Converting any page-relative path to a context-relative path starting with a slash (/)
2. Adding any additional parameters
3. Optionally adding lastModified parameter
4. Converting any context-relative path to a site-relative path by prefixing contextPath
5. Encoding any URL path characters not defined in RFC 3986: Reserved Characters
6. Rewrite with response.encodeURL

Throws:

MalformedURLException

UnsupportedEncodingException

buildUrl

public static String buildUrl(PageContext pageContext,
                              String href,
                              HttpParameters params,
                              boolean hrefAbsolute,
                              LastModifiedServlet.AddLastModifiedWhen addLastModified)
                       throws MalformedURLException,
                              UnsupportedEncodingException

Throws:

MalformedURLException

UnsupportedEncodingException

See Also:

buildUrl(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, com.aoindustries.net.HttpParameters, boolean, com.aoindustries.servlet.http.LastModifiedServlet.AddLastModifiedWhen)

buildUrl

public static String buildUrl(JspContext jspContext,
                              String src,
                              HttpParameters params,
                              boolean srcAbsolute,
                              LastModifiedServlet.AddLastModifiedWhen addLastModified)
                       throws MalformedURLException,
                              UnsupportedEncodingException

Throws:

MalformedURLException

UnsupportedEncodingException

See Also:

buildUrl(javax.servlet.jsp.PageContext, java.lang.String, com.aoindustries.net.HttpParameters, boolean, com.aoindustries.servlet.http.LastModifiedServlet.AddLastModifiedWhen)