WebUtil (Fujion Core Libraries 2.0.0-RC1 API)

java.lang.Object
- org.fujion.core.WebUtil

```
public class WebUtil
extends Object
```
Utility methods for accessing and manipulating web resources and settings.

Field Summary

Fields
Modifier and Type Field and Description

static String FUJION_VERSION

Fields
Modifier and Type	Field and Description
`static String`	`FUJION_VERSION`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`addQueryString(String url, String queryString)` Adds the specified query string to the url.
`static String`	`decodeCookieValue(String encodedCookieValue)` Decodes an encoded cookie value
`static String`	`encodeCookieValue(String cookieValuePlainText)` Encodes a plain text cookie value.
`static String`	`getBaseUrl()` Returns the base url from the execution context.
`static javax.servlet.http.Cookie`	`getCookie(String cookieName)` Returns the named cookie from the current request.
`static javax.servlet.http.Cookie`	`getCookie(String cookieName, javax.servlet.http.HttpServletRequest httpRequest)` Returns the named cookie from the specified request.
`static String`	`getCookieValue(String cookieName)` Returns the value from the named cookie from the specified request.
`static String`	`getCookieValue(String cookieName, javax.servlet.http.HttpServletRequest httpRequest)` Returns the value from the named cookie from the specified request.
`static String`	`getQueryParams()` Returns the query parameter string from the request url.
`static String`	`getRequestUrl()` Returns the original request url from the execution context.
`static org.springframework.core.io.Resource`	`getResource(String src)` Returns the resource corresponding to the source URL.
`static boolean`	`isDebugEnabled()` Returns the debug state of the servlet.
`static Map<String,String>`	`queryStringToMap(String queryString)` Converts the queryString to a map.
`static Map<String,String>`	`queryStringToMap(String queryString, String valueDelimiter)` Converts the queryString to a map.
`static javax.servlet.http.Cookie`	`setCookie(String cookieName, String value, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.http.HttpServletRequest httpRequest)` Sets a cookie into the response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FUJION_VERSION
```
public static final String FUJION_VERSION
```
- Method Detail
  - isDebugEnabled
```
public static boolean isDebugEnabled()
```
    Returns the debug state of the servlet. When enabled, the debug state can affect various application behaviors such as disabling javascript minification.
    
    Returns:
    
    The debug state.
  - queryStringToMap
```
public static Map<String,String> queryStringToMap(String queryString)
```
    Converts the queryString to a map.
    
    Parameters:
    
    queryString - The query string (leading "?" is optional)
    
    Returns:
    
    A map containing the parameters from the query string. This may return null if the queryString is empty. Multiple values for a parameter are separated by commas.
  - queryStringToMap
```
public static Map<String,String> queryStringToMap(String queryString,
                                                  String valueDelimiter)
```
    Converts the queryString to a map.
    
    Parameters:
    
    queryString - The query string (leading "?" is optional)
    
    valueDelimiter - String to use to delimit multiple values for a parameter. May be null.
    
    Returns:
    
    A map containing the arguments from the query string. This may return null if the queryString is empty.
  - addQueryString
```
public static String addQueryString(String url,
                                    String queryString)
```
    Adds the specified query string to the url.
    
    Parameters:
    
    url - url to receive the query string.
    
    queryString - Query string to add.
    
    Returns:
    
    The updated url.
    
    Throws:
    
    IllegalArgumentException - if url is null
  - getQueryParams
```
public static String getQueryParams()
```
    Returns the query parameter string from the request url.
    
    Returns:
    
    The query parameter string or empty string if none.
  - getRequestUrl
```
public static String getRequestUrl()
```
    Returns the original request url from the execution context.
    
    Returns:
    
    The request url of the browser document.
  - getBaseUrl
```
public static String getBaseUrl()
```
    Returns the base url from the execution context.
    
    Returns:
    
    The base url.
  - getCookie
```
public static javax.servlet.http.Cookie getCookie(String cookieName)
```
    Returns the named cookie from the current request.
    
    Parameters:
    
    cookieName - Name of cookie.
    
    Returns:
    
    A cookie, or null if not found.
    
    See Also:
    
    getCookie(String, HttpServletRequest)
  - getCookie
```
public static javax.servlet.http.Cookie getCookie(String cookieName,
                                                  javax.servlet.http.HttpServletRequest httpRequest)
```
    Returns the named cookie from the specified request. When values are retrieved, they should be decoded.
    
    Parameters:
    
    cookieName - Name of cookie
    
    httpRequest - Request containing cookie.
    
    Returns:
    
    A cookie, or null if not found.
    
    Throws:
    
    IllegalArgumentException - if arguments are null
    
    See Also:
    
    decodeCookieValue(String)
  - getCookieValue
```
public static String getCookieValue(String cookieName)
```
    Returns the value from the named cookie from the specified request. The value is decoded.
    
    Parameters:
    
    cookieName - Name of cookie
    
    Returns:
    
    A cookie value, or null if not found.
    
    Throws:
    
    IllegalArgumentException - if argument is null or if underlying HttpServletRequest is null
    
    See Also:
    
    getCookieValue(String, HttpServletRequest)
  - getCookieValue
```
public static String getCookieValue(String cookieName,
                                    javax.servlet.http.HttpServletRequest httpRequest)
```
    Returns the value from the named cookie from the specified request. The value is decoded with for security and consistency (Version 0+ of Cookies and web containers)
    
    Parameters:
    
    cookieName - Name of cookie
    
    httpRequest - Request containing cookie.
    
    Returns:
    
    A cookie value, or null if not found.
    
    Throws:
    
    IllegalArgumentException - if arguments are null
    
    See Also:
    
    getCookie(String, HttpServletRequest), decodeCookieValue(String)
  - encodeCookieValue
```
public static String encodeCookieValue(String cookieValuePlainText)
```
    Encodes a plain text cookie value.
    Note: The direction to use a two-phase encode/decode process (i.e. instead of the Base64 class URL_SAFE option) was intentional
    
    Parameters:
    
    cookieValuePlainText - The plain text to encode
    
    Returns:
    
    encoded cookie value
    
    Throws:
    
    IllegalArgumentException - If the argument is null
    
    See Also:
    
    URLEncoder.encode(String, String), Base64.encodeBase64String(byte[])
  - decodeCookieValue
```
public static String decodeCookieValue(String encodedCookieValue)
```
    Decodes an encoded cookie value
    Note: The direction to use a two-phase encode/decode process (i.e. instead of the Base64 class URL_SAFE option) was intentional
    
    Parameters:
    
    encodedCookieValue - The encoded cookie value
    
    Returns:
    
    decoded cookie value
    
    Throws:
    
    IllegalArgumentException - If the argument is null
    
    See Also:
    
    URLDecoder.decode(String, String), BaseNCodec.decode(String)
  - setCookie
```
public static javax.servlet.http.Cookie setCookie(String cookieName,
                                                  String value,
                                                  javax.servlet.http.HttpServletResponse httpResponse,
                                                  javax.servlet.http.HttpServletRequest httpRequest)
```
    Sets a cookie into the response. Cookies are URLEncoded for consistency (Version 0+ of Cookies)
    
    Parameters:
    
    cookieName - Name of cookie.
    
    value - Value of cookie. If null, the cookie is removed from the client if it exists.
    
    httpResponse - Response object.
    
    httpRequest - Request object.
    
    Returns:
    
    Newly created cookie.
    
    Throws:
    
    IllegalArgumentException - if cookieName, httpResponse, or httpRequest arguments are null
  - getResource
```
public static org.springframework.core.io.Resource getResource(String src)
```
    Returns the resource corresponding to the source URL.
    
    Parameters:
    
    src - The URL of the source.
    
    Returns:
    
    The corresponding resource.

Class WebUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FUJION_VERSION

Method Detail

isDebugEnabled

queryStringToMap

queryStringToMap

addQueryString

getQueryParams

getRequestUrl

getBaseUrl

getCookie

getCookie

getCookieValue

getCookieValue

encodeCookieValue

decodeCookieValue

setCookie

getResource