org.omnifaces.util

Class Servlets

java.lang.Object

org.omnifaces.util.Servlets

public final class Servlets
extends java.lang.Object

Collection of utility methods for the Servlet API in general.

Since:

1.6

Author:

Arjan Tijms, Bauke Scholtz

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	getApplicationAttribute(javax.servlet.ServletContext context, java.lang.String name) Returns the application scope attribute value associated with the given name.
static java.lang.String	getRequestBaseURL(javax.servlet.http.HttpServletRequest request) Returns the HTTP request base URL.
static java.lang.String	getRequestDomainURL(javax.servlet.http.HttpServletRequest request) Returns the HTTP request domain URL.
static java.lang.String	getRequestHostname(javax.servlet.http.HttpServletRequest request) Returns the HTTP request hostname.
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestQueryStringMap(javax.servlet.http.HttpServletRequest request) Returns the HTTP request query string as parameter values map.
static java.lang.String	getRequestURIWithQueryString(javax.servlet.http.HttpServletRequest request) Returns the HTTP request URI with query string.
static java.lang.String	getRequestURLWithQueryString(javax.servlet.http.HttpServletRequest request) Returns the HTTP request URL with query string.
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	toParameterMap(java.lang.String queryString) Converts the given query string to request parameter values map.

Methods inherited from class java.lang.Object

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

Method Detail

getRequestHostname

public static java.lang.String getRequestHostname(javax.servlet.http.HttpServletRequest request)

Returns the HTTP request hostname. This is the entire domain, without any scheme and slashes. Noted should be that this value is extracted from the request URL, not from ServletRequest.getServerName() as its outcome can be influenced by proxies.

Parameters:

request - The involved HTTP servlet request.

Returns:

The HTTP request hostname.

Throws:

java.lang.IllegalArgumentException - When the URL is malformed. This is however unexpected as the request would otherwise not have hit the server at all.

See Also:

HttpServletRequest.getRequestURL()

getRequestDomainURL

public static java.lang.String getRequestDomainURL(javax.servlet.http.HttpServletRequest request)

Returns the HTTP request domain URL. This is the URL with the scheme and domain, without any trailing slash.

Parameters:

request - The involved HTTP servlet request.

Returns:

The HTTP request domain URL.

See Also:

HttpServletRequest.getRequestURL(), HttpServletRequest.getRequestURI()

getRequestBaseURL

public static java.lang.String getRequestBaseURL(javax.servlet.http.HttpServletRequest request)

Returns the HTTP request base URL. This is the URL from the scheme, domain until with context path, including the trailing slash. This is the value you could use in HTML <base> tag.

Parameters:

request - The involved HTTP servlet request.

Returns:

The HTTP request base URL.

See Also:

HttpServletRequest.getRequestURL(), HttpServletRequest.getRequestURI(), HttpServletRequest.getContextPath()

getRequestURLWithQueryString

public static java.lang.String getRequestURLWithQueryString(javax.servlet.http.HttpServletRequest request)

Returns the HTTP request URL with query string. This is the full request URL with query string as the enduser sees in browser address bar.

Parameters:

request - The involved HTTP servlet request.

Returns:

The HTTP request URL with query string.

See Also:

HttpServletRequest.getRequestURL(), HttpServletRequest.getQueryString()

getRequestURIWithQueryString

public static java.lang.String getRequestURIWithQueryString(javax.servlet.http.HttpServletRequest request)

Returns the HTTP request URI with query string. This is the part after the domain in the request URL, including the leading slash and the request query string.

Parameters:

request - The involved HTTP servlet request.

Returns:

The HTTP request URI with query string.

See Also:

HttpServletRequest.getRequestURI(), HttpServletRequest.getQueryString()

getRequestQueryStringMap

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestQueryStringMap(javax.servlet.http.HttpServletRequest request)

Returns the HTTP request query string as parameter values map. Note this method returns only the request URL (GET) parameters, as opposed to ServletRequest.getParameterMap(), which contains both the request URL (GET) parameters and and the request body (POST) parameters. The map entries are in the same order as they appear in the query string.

Parameters:

request - The request for which the base URL is computed.

Returns:

The HTTP request query string as parameter values map.

toParameterMap

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> toParameterMap(java.lang.String queryString)

Converts the given query string to request parameter values map.

Parameters:

queryString - The query string.

Returns:

The query string as parameter values map.

Since:

1.7

getApplicationAttribute

public static <T> T getApplicationAttribute(javax.servlet.ServletContext context,
                            java.lang.String name)

Returns the application scope attribute value associated with the given name.

Parameters:

context - The servlet context used for looking up the attribute.

name - The application scope attribute name.

Returns:

The application scope attribute value associated with the given name.

Throws:

java.lang.ClassCastException - When T is of wrong type.

See Also:

ServletContext.getAttribute(String)