RequestUtils (ActiveWeb - Root 1.13 API)

java.lang.Object
- org.javalite.activeweb.RequestUtils

```
public class RequestUtils
extends Object
```
TODO: this needs to become a default interface, once we move the project to java 8

Author:

igor, on 6/16/14.

Constructor Summary

Constructors
Constructor and Description

RequestUtils()

Constructors
Constructor and Description
`RequestUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static AppContext`	`appContext()` Returns instance of `AppContext`.
`static String`	`context()` Provides a context of the request - usually an app name (as seen on URL of request).
`static Cookie`	`cookie(String name)` Returns a cookie by name, null if not found.
`static List<Cookie>`	`cookies()` Returns collection of all cookies browser sent.
`static String`	`cookieValue(String name)` Convenience method, returns cookie value.
`static boolean`	`exists(String name)` Tests if a request parameter exists.
`static String`	`format()` Returns a format part of the URI, or null if URI does not have a format part.
`static String`	`getId()` Returns value of ID if one is present on a URL.
`static Locale`	`getLocale()` Same as `locale()`.
`static String`	`getRequestHost()` This method returns a host name of a web server if this container is fronted by one, such that it sets a header `X-Forwarded-Host` on the request and forwards it to the Java container.
`static int`	`getRequestPort()` This method returns a port of a web server if this Java container is fronted by one, such that it sets a header `X-Forwarded-Port` on the request and forwards it to the Java container.
`static String`	`getRequestProtocol()` This method returns a protocol of a request to web server if this container is fronted by one, such that it sets a header `X-Forwarded-Proto` on the request and forwards it to the Java container.
`static Route`	`getRoute()` Returns instance of `Route` to be used for potential conditional logic inside controller filters.
`static String`	`header(String name)` Returns a request header by name.
`static Map<String,String>`	`headers()` Returns all headers from a request keyed by header name.
`static String`	`host()` Returns local host name on which request was received.
`static String`	`ipAddress()` Returns local IP address on which request was received.
`static String`	`ipForwardedFor()` Returns IP address that the web server forwarded request for.
`static boolean`	`isDelete()` True if this request uses HTTP DELETE method, false otherwise.
`static boolean`	`isGet()` True if this request uses HTTP GET method, false otherwise.
`static boolean`	`isHead()` True if this request uses HTTP HEAD method, false otherwise.
`static boolean`	`isMethod(String method)`
`static boolean`	`isPost()` True if this request uses HTTP POST method, false otherwise.
`static boolean`	`isPut()` True if this request uses HTTP PUT method, false otherwise.
`static boolean`	`isXhr()` Returns true if this request is Ajax.
`static Locale`	`locale()` Returns locale of request.
`static String`	`method()` Returns an HTTP method from the request.
`static String`	`param(String name)` Returns value of routing user segment, or route wild card value, or request parameter.
`static String`	`param(String name, List<FormItem> formItems)` Convenience method to get a parameter value in case `multipart/form-data` request was used.
`static Map<String,String[]>`	`params()` Returns an instance of `java.util.Map` containing parameter names as keys and parameter values as map values.
`static List<String>`	`params(String name)` Returns multiple request values for a name.
`static List<String>`	`params(String name, List<FormItem> formItems)` Convenience method to get parameter values in case `multipart/form-data` request was used.
`static Map<String,String>`	`params1st()` Returns a map where keys are names of all parameters, while values are the first value for each parameter, even if such parameter has more than one value submitted.
`static Map<String,String>`	`params1st(List<FormItem> formItems)` Convenience method to get parameters in case `multipart/form-data` request was used.
`static String`	`path()` Returns a path of the request.
`static int`	`port()` Returns port on which the of the server received current request.
`static String`	`protocol()` Returns protocol of request, for example: HTTP/1.1.
`static String`	`queryString()` Returns query string of the request.
`static String`	`remoteAddress()` IP address of the requesting client.
`static String`	`remoteHost()` Host name of the requesting client.
`static boolean`	`requestHas(String name)` Synonym of `exists(String)`.
`static String`	`uri()` Returns URI, or a full path of request.
`static String`	`url()` Returns a full URL of the request, all except a query string.
`static String`	`userAgent()` Helper method, returns user-agent header of the request.
`static boolean`	`xhr()` Synonym for `isXhr()`.

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

- Constructor Detail
  - RequestUtils
```
public RequestUtils()
```
- Method Detail
  - param
```
public static String param(String name)
```
    Returns value of routing user segment, or route wild card value, or request parameter. If this name represents multiple values, this call will result in IllegalArgumentException.
    
    Parameters:
    name - name of parameter.
    
    Returns:
    value of routing user segment, or route wild card value, or request parameter.
  - param
```
public static String param(String name,
           List<FormItem> formItems)
```
    Convenience method to get a parameter value in case multipart/form-data request was used. Returns a value of one named parameter from request. Will only return form fields, and not files.
    
    Parameters:
    name - name of parameter.
    formItems - form items retrieved from multipart/form-data request.
    
    Returns:
    value of request parameter from multipart/form-data request or null if not found.
  - getId
```
public static String getId()
```
    Returns value of ID if one is present on a URL. Id is usually a part of a URI, such as: /controller/action/id. This depends on a type of a URI, and whether controller is RESTful or not.
    
    Returns:
    ID value from URI is one exists, null if not.
  - format
```
public static String format()
```
    Returns a format part of the URI, or null if URI does not have a format part. A format part is defined as part of URI that is trailing after a last dot, as in: /books.xml, here "xml" is a format.
    
    Returns:
    format part of the URI, or nul if URI does not have it.
  - appContext
```
public static AppContext appContext()
```
    Returns instance of AppContext.
    
    Returns:
    instance of AppContext.
  - isXhr
```
public static boolean isXhr()
```
    Returns true if this request is Ajax.
    
    Returns:
    true if this request is Ajax.
  - userAgent
```
public static String userAgent()
```
    Helper method, returns user-agent header of the request.
    
    Returns:
    user-agent header of the request.
  - xhr
```
public static boolean xhr()
```
    Synonym for isXhr().
  - getRoute
```
public static Route getRoute()
```
    Returns instance of Route to be used for potential conditional logic inside controller filters.
    
    Returns:
    instance of Route
  - exists
```
public static boolean exists(String name)
```
    Tests if a request parameter exists. Disregards the value completely - this can be empty string, but as long as parameter does exist, this method returns true.
    
    Parameters:
    name - name of request parameter to test.
    
    Returns:
    true if parameter exists, false if not.
  - requestHas
```
public static boolean requestHas(String name)
```
    Synonym of exists(String).
    
    Parameters:
    name - name of request parameter to test.
    
    Returns:
    true if parameter exists, false if not.
  - host
```
public static String host()
```
    Returns local host name on which request was received.
    
    Returns:
    local host name on which request was received.
  - ipAddress
```
public static String ipAddress()
```
    Returns local IP address on which request was received.
    
    Returns:
    local IP address on which request was received.
  - getRequestProtocol
```
public static String getRequestProtocol()
```
    This method returns a protocol of a request to web server if this container is fronted by one, such that it sets a header X-Forwarded-Proto on the request and forwards it to the Java container. If such header is not present, than the protocol() method is used.
    
    Returns:
    protocol of web server request if X-Forwarded-Proto header is found, otherwise current protocol.
  - getRequestPort
```
public static int getRequestPort()
```
    This method returns a port of a web server if this Java container is fronted by one, such that it sets a header X-Forwarded-Port on the request and forwards it to the Java container. If such header is not present, than the port() method is used.
    
    Returns:
    port of web server request if X-Forwarded-Port header is found, otherwise port of the Java container.
  - port
```
public static int port()
```
    Returns port on which the of the server received current request.
    
    Returns:
    port on which the of the server received current request.
  - protocol
```
public static String protocol()
```
    Returns protocol of request, for example: HTTP/1.1.
    
    Returns:
    protocol of request
  - getRequestHost
```
public static String getRequestHost()
```
    This method returns a host name of a web server if this container is fronted by one, such that it sets a header X-Forwarded-Host on the request and forwards it to the Java container. If such header is not present, than the host() method is used.
    
    Returns:
    host name of web server if X-Forwarded-Host header is found, otherwise local host name.
  - ipForwardedFor
```
public static String ipForwardedFor()
```
    Returns IP address that the web server forwarded request for.
    
    Returns:
    IP address that the web server forwarded request for.
  - params
```
public static List<String> params(String name)
```
    Returns multiple request values for a name.
    
    Parameters:
    name - name of multiple values from request.
    
    Returns:
    multiple request values for a name.
  - params
```
public static List<String> params(String name,
                  List<FormItem> formItems)
```
    Convenience method to get parameter values in case multipart/form-data request was used. Returns multiple request values for a name.
    
    Parameters:
    name - name of multiple values from request.
    formItems - form items retrieved from multipart/form-data request.
    
    Returns:
    multiple request values for a name. Will ignore files, and only return form fields.
  - params1st
```
public static Map<String,String> params1st()
```
    Returns a map where keys are names of all parameters, while values are the first value for each parameter, even if such parameter has more than one value submitted.
    
    Returns:
    a map where keys are names of all parameters, while values are first value for each parameter, even if such parameter has more than one value submitted.
  - params1st
```
public static Map<String,String> params1st(List<FormItem> formItems)
```
    Convenience method to get parameters in case multipart/form-data request was used. Returns a map where keys are names of all parameters, while values are the first value for each parameter, even if such parameter has more than one value submitted.
    
    Parameters:
    formItems - form items retrieved from multipart/form-data request.
    
    Returns:
    a map where keys are names of all parameters, while values are first value for each parameter, even if such parameter has more than one value submitted.
  - params
```
public static Map<String,String[]> params()
```
    Returns an instance of java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
    
    Returns:
    an instance java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
  - locale
```
public static Locale locale()
```
    Returns locale of request.
    
    Returns:
    locale of request.
  - getLocale
```
public static Locale getLocale()
```
    Same as locale().
    
    Returns:
    locale of request.
  - cookies
```
public static List<Cookie> cookies()
```
    Returns collection of all cookies browser sent.
    
    Returns:
    collection of all cookies browser sent.
  - cookie
```
public static Cookie cookie(String name)
```
    Returns a cookie by name, null if not found.
    
    Parameters:
    name - name of a cookie.
    
    Returns:
    a cookie by name, null if not found.
  - cookieValue
```
public static String cookieValue(String name)
```
    Convenience method, returns cookie value.
    
    Parameters:
    name - name of cookie.
    
    Returns:
    cookie value.
  - path
```
public static String path()
```
    Returns a path of the request. It does not include protocol, host, port or context. Just a path. Example: /controller/action/id
    
    Returns:
    a path of the request.
  - url
```
public static String url()
```
    Returns a full URL of the request, all except a query string.
    
    Returns:
    a full URL of the request, all except a query string.
  - queryString
```
public static String queryString()
```
    Returns query string of the request.
    
    Returns:
    query string of the request.
  - method
```
public static String method()
```
    Returns an HTTP method from the request.
    
    Returns:
    an HTTP method from the request.
  - isGet
```
public static boolean isGet()
```
    True if this request uses HTTP GET method, false otherwise.
    
    Returns:
    True if this request uses HTTP GET method, false otherwise.
  - isPost
```
public static boolean isPost()
```
    True if this request uses HTTP POST method, false otherwise.
    
    Returns:
    True if this request uses HTTP POST method, false otherwise.
  - isPut
```
public static boolean isPut()
```
    True if this request uses HTTP PUT method, false otherwise.
    
    Returns:
    True if this request uses HTTP PUT method, false otherwise.
  - isDelete
```
public static boolean isDelete()
```
    True if this request uses HTTP DELETE method, false otherwise.
    
    Returns:
    True if this request uses HTTP DELETE method, false otherwise.
  - isMethod
```
public static boolean isMethod(String method)
```
  - isHead
```
public static boolean isHead()
```
    True if this request uses HTTP HEAD method, false otherwise.
    
    Returns:
    True if this request uses HTTP HEAD method, false otherwise.
  - context
```
public static String context()
```
    Provides a context of the request - usually an app name (as seen on URL of request). Example: /mywebapp
    
    Returns:
    a context of the request - usually an app name (as seen on URL of request).
  - uri
```
public static String uri()
```
    Returns URI, or a full path of request. This does not include protocol, host or port. Just context and path. Examlpe: /mywebapp/controller/action/id
    
    Returns:
    URI, or a full path of request.
  - remoteHost
```
public static String remoteHost()
```
    Host name of the requesting client.
    
    Returns:
    host name of the requesting client.
  - remoteAddress
```
public static String remoteAddress()
```
    IP address of the requesting client.
    
    Returns:
    IP address of the requesting client.
  - header
```
public static String header(String name)
```
    Returns a request header by name.
    
    Parameters:
    name - name of header
    
    Returns:
    header value.
  - headers
```
public static Map<String,String> headers()
```
    Returns all headers from a request keyed by header name.
    
    Returns:
    all headers from a request keyed by header name.

Class RequestUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestUtils

Method Detail

param

param

getId

format

appContext

isXhr

userAgent

xhr

getRoute

exists

requestHas

host

ipAddress

getRequestProtocol

getRequestPort

port

protocol

getRequestHost

ipForwardedFor

params

params

params1st

params1st

params

locale

getLocale

cookies

cookie

cookieValue

path

url

queryString

method

isGet

isPost

isPut

isDelete

isMethod

isHead

context

uri

remoteHost

remoteAddress

header

headers