Servlets

java.lang.Object
- org.omnifaces.util.Servlets

```
public final class Servlets
extends 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(ServletContext context, String name)` Returns the application scope attribute value associated with the given name.
`static String`	`getForwardRequestQueryString(HttpServletRequest request)` Returns the original HTTP request query string behind this forwarded request, if any.
`static String`	`getForwardRequestURI(HttpServletRequest request)` Returns the original HTTP request URI behind this forwarded request, if any.
`static String`	`getForwardRequestURIWithQueryString(HttpServletRequest request)` Returns the original HTTP request URI with query string behind this forwarded request, if any.
`static String`	`getRequestBaseURL(HttpServletRequest request)` Returns the HTTP request base URL.
`static String`	`getRequestDomainURL(HttpServletRequest request)` Returns the HTTP request domain URL.
`static String`	`getRequestHostname(HttpServletRequest request)` Returns the HTTP request hostname.
`static Map<String,List<String>>`	`getRequestQueryStringMap(HttpServletRequest request)` Returns the HTTP request query string as parameter values map.
`static String`	`getRequestRelativeURI(HttpServletRequest request)` Returns the HTTP request URI relative to the context root of a web application.
`static String`	`getRequestRelativeURIWithoutPathParameters(HttpServletRequest request)` Returns the HTTP request URI relative to the context root of a web application.
`static String`	`getRequestURIWithQueryString(HttpServletRequest request)` Returns the HTTP request URI with query string.
`static String`	`getRequestURLWithQueryString(HttpServletRequest request)` Returns the HTTP request URL with query string.
`static Map<String,List<String>>`	`toParameterMap(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 String getRequestHostname(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:
    
    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 String getRequestDomainURL(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 String getRequestBaseURL(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()
  - getRequestRelativeURI
```
public static String getRequestRelativeURI(HttpServletRequest request)
```
    Returns the HTTP request URI relative to the context root of a web application. This is the request URI minus the context path. Note that this includes path parameters.
    
    Parameters:
    request - The involved HTTP servlet request.
    
    Returns:
    the request URI relative to the context root
    Since:
    
    1.8
  - getRequestRelativeURIWithoutPathParameters
```
public static String getRequestRelativeURIWithoutPathParameters(HttpServletRequest request)
```
    Returns the HTTP request URI relative to the context root of a web application. This is the servlet path plus the path info (if any).
    
    Parameters:
    request - The involved HTTP servlet request.
    
    Returns:
    the request URI relative to the context root
    Since:
    
    1.8
  - getRequestURLWithQueryString
```
public static String getRequestURLWithQueryString(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 String getRequestURIWithQueryString(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 Map<String,List<String>> getRequestQueryStringMap(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.
  - getForwardRequestURI
```
public static String getForwardRequestURI(HttpServletRequest request)
```
    Returns the original HTTP request URI behind this forwarded request, if any. This does not include the request query string.
    
    Returns:
    The original HTTP request URI behind this forwarded request, if any.
    Since:
    
    1.8
  - getForwardRequestQueryString
```
public static String getForwardRequestQueryString(HttpServletRequest request)
```
    Returns the original HTTP request query string behind this forwarded request, if any.
    
    Returns:
    The original HTTP request query string behind this forwarded request, if any.
    Since:
    
    1.8
  - getForwardRequestURIWithQueryString
```
public static String getForwardRequestURIWithQueryString(HttpServletRequest request)
```
    Returns the original HTTP request URI with query string behind this forwarded request, if any.
    
    Returns:
    The original HTTP request URI with query string behind this forwarded request, if any.
    Since:
    
    1.8
  - toParameterMap
```
public static Map<String,List<String>> toParameterMap(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(ServletContext context,
                            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:
    
    ClassCastException - When T is of wrong type.
    See Also:
    ServletContext.getAttribute(String)

Class Servlets

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRequestHostname

getRequestDomainURL

getRequestBaseURL

getRequestRelativeURI

getRequestRelativeURIWithoutPathParameters

getRequestURLWithQueryString

getRequestURIWithQueryString

getRequestQueryStringMap

getForwardRequestURI

getForwardRequestQueryString

getForwardRequestURIWithQueryString

toParameterMap

getApplicationAttribute