com.aoindustries.net

Class UrlUtils

java.lang.Object

com.aoindustries.net.UrlUtils

public class UrlUtils
extends Object

Encoding helper utilities. TODO: Rename to EncodingUtils once com.aoindustries.util.EncodingUtils has been eliminated.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method and Description
static String	buildUrl(javax.servlet.jsp.JspContext jspContext, String src, HttpParameters params, boolean srcAbsolute, LastModifiedServlet.AddLastModifiedWhen addLastModified)
static String	buildUrl(javax.servlet.jsp.PageContext pageContext, String href, HttpParameters params, boolean hrefAbsolute, LastModifiedServlet.AddLastModifiedWhen addLastModified)
static String	buildUrl(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.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 URL up to the first ?, if present.

Methods inherited from class java.lang.Object

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

Method Detail

encodeUrlPath

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

Encodes the URL up to the first ?, if present. Does not encode any characters in the set { '?', ':', '/', ';', '#', '+' }. Encodes tel: (case-sensitive) urls by relacing spaces with hyphens.

Throws:

UnsupportedEncodingException

See Also:

#decodeUrlPath(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 in the set { '?', ':', '/', ';', '#', '+' }. Does not decode tel: urls (case-sensitive).

Throws:

UnsupportedEncodingException

See Also:

#encodeUrlPath(java.lang.String)

buildUrl

public static String buildUrl(javax.servlet.ServletContext servletContext,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.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 non-ASCII characters in the URL path
6. Rewrite with response.encodeURL

Throws:

MalformedURLException

UnsupportedEncodingException

buildUrl

public static String buildUrl(javax.servlet.jsp.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)

buildUrl

public static String buildUrl(javax.servlet.jsp.JspContext jspContext,
                              String src,
                              HttpParameters params,
                              boolean srcAbsolute,
                              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)