HttpSupport (JavaLite - Java, light as a feather 2.3.1-j8-SNAPSHOT API)

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

Direct Known Subclasses:

AppController, HttpSupportFilter
```
public class HttpSupport
extends Object
```
Author:

Igor Polevoy

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class HttpSupport.HttpBuilder

class HttpSupport.RenderBuilder

Nested Classes
Modifier and Type	Class and Description
`class`	`HttpSupport.HttpBuilder`
`class`	`HttpSupport.RenderBuilder`

Constructor Summary

Constructors
Constructor and Description

HttpSupport()

Constructors
Constructor and Description
`HttpSupport()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected AppContext`	`appContext()` Returns instance of `AppContext`.
`protected void`	`assign(String name, Object value)` Assigns a value for a view.
`protected boolean`	`blank(String... names)` Returns true if any named request parameter is blank.
`protected String`	`context()` Provides a context of the request - usually an app name (as seen on URL of request).
`Cookie`	`cookie(String name)` Returns a cookie by name, null if not found.
`List<Cookie>`	`cookies()` Returns collection of all cookies browser sent.
`protected String`	`cookieValue(String name)` Convenience method, returns cookie value.
`protected void`	`encoding(String encoding)` Synonym for `setEncoding(String)`
`protected boolean`	`exists(String name)` Tests if a request parameter exists.
`protected void`	`flash(Map values)` Flash method to display multiple flash messages.
`protected void`	`flash(Object... values)` Flash method to display multiple flash messages.
`protected void`	`flash(String name)` Sets a flash name for a flash with a body.
`protected void`	`flash(String name, Object value)` Sends value to flash.
`protected String`	`format()` Returns a format part of the URI, or null if URI does not have a format part.
`protected String`	`getEncoding()` Controllers can override this method to return encoding they require.
`protected FileItem`	`getFile(String fieldName, List<FormItem> formItems)` Convenience method to get file content from `multipart/form-data` request.
`protected javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()` Direct access to current `HttpServletRequest` for low level operations.
`protected javax.servlet.http.HttpServletResponse`	`getHttpServletResponse()` Direct access to current `HttpServletResponse` for low level operations.
`protected String`	`getId()` Returns value of ID if one is present on a URL.
`protected Locale`	`getLocale()` Same as `locale()`.
`Map<String,String>`	`getMap(String hashName)` Returns a map parsed from a request if parameter names have a "hash" syntax:
`Map<String,String>`	`getMap(String hashName, List<FormItem> formItems)` Convenience method to get parameter map in case `multipart/form-data` request was used.
`protected String`	`getRealPath(String path)` Returns a String containing the real path for a given virtual path.
`protected byte[]`	`getRequestBytes()` Reads entire request data as byte array.
`protected 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.
`protected InputStream`	`getRequestInputStream()` Returns InputStream of the request.
`protected 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.
`protected 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.
`protected InputStream`	`getRequestStream()` Alias to `getRequestInputStream()`.
`protected String`	`getRequestString()` Reads entire request data as String.
`Map<String,String>`	`getResponseHeaders()` Returns response headers
`protected Route`	`getRoute()` Returns instance of `Route` to be used for potential conditional logic inside controller filters.
`protected String`	`header(String name)` Returns a request header by name.
`protected void`	`header(String name, Object value)` Adds a header to response.
`protected void`	`header(String name, String value)` Adds a header to response.
`protected Map<String,String>`	`headers()` Returns all headers from a request keyed by header name.
`protected String`	`host()` Returns local host name on which request was received.
`protected String`	`ipAddress()` Returns local IP address on which request was received.
`protected String`	`ipForwardedFor()` Returns IP address that the web server forwarded request for.
`protected boolean`	`isDelete()` True if this request uses HTTP DELETE method, false otherwise.
`protected boolean`	`isGet()` True if this request uses HTTP GET method, false otherwise.
`protected boolean`	`isHead()` True if this request uses HTTP HEAD method, false otherwise.
`protected boolean`	`isPost()` True if this request uses HTTP POST method, false otherwise.
`protected boolean`	`isPut()` True if this request uses HTTP PUT method, false otherwise.
`protected boolean`	`isXhr()` Returns true if this request is Ajax.
`protected List`	`jsonList()` Converts posted JSON array to a Java List.
`protected Map`	`jsonMap()` Converts posted JSON map to a Java Map.
`protected Map[]`	`jsonMaps()` Converts posted JSON maps to a Java Maps array.
`protected Locale`	`locale()` Returns locale of request.
`protected void`	`locale(Locale locale)` Same as `setLocale(java.util.Locale)`
`protected void`	`logDebug(String info)`
`protected void`	`logError(String info)`
`protected void`	`logError(String info, Throwable e)`
`protected void`	`logError(Throwable e)`
`protected void`	`logInfo(String info)`
`protected void`	`logWarning(String info)`
`protected void`	`logWarning(String info, Throwable e)`
`protected String`	`merge(String template, Map values)` Will merge a template and return resulting string.
`protected String`	`method()` Returns an HTTP method from the request.
`protected List<FormItem>`	`multipartFormItems()` Convenience method, calls `multipartFormItems(String)`.
`protected List<FormItem>`	`multipartFormItems(String encoding)` Returns a collection of uploaded files and form fields from a multi-part request.
`protected List<FormItem>`	`multipartFormItems(String encoding, long maxUploadSize)` Returns a collection of uploaded files and form fields from a multi-part request.
`protected OutputStream`	`outputStream()` Use to send raw data to HTTP client.
`protected OutputStream`	`outputStream(String contentType)` Use to send raw data to HTTP client.
`protected OutputStream`	`outputStream(String contentType, Map headers, int status)` Use to send raw data to HTTP client.
`protected String`	`param(String name)` Returns value of one named parameter from request.
`protected String`	`param(String name, List<FormItem> formItems)` Convenience method to get a parameter in case `multipart/form-data` request was used.
`protected Map<String,String[]>`	`params()` Returns an instance of `java.util.Map` containing parameter names as keys and parameter values as map values.
`protected List<String>`	`params(String name)` Returns multiple request values for a name.
`protected List<String>`	`params(String name, List<FormItem> formItems)` Convenience method to get parameters in case `multipart/form-data` request was used.
`protected Map<String,String>`	`params1st()` 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.
`protected Map<String,String>`	`params1st(List<FormItem> formItems)` Convenience method to get first parameter values in case `multipart/form-data` request was used.
`protected String`	`path()` Returns a path of the request.
`protected int`	`port()` Returns port on which the of the server received current request.
`protected String`	`protocol()` Returns protocol of request, for example: HTTP/1.1.
`protected String`	`queryString()` Returns query string of the request.
`protected HttpSupport.HttpBuilder`	`redirect()` Redirects to the same controller, and action "index".
`protected <T extends AppController> HttpSupport.HttpBuilder`	`redirect(Class<T> controllerClass)` Redirects to given controller, action "index" without any parameters.
`protected <T extends AppController> HttpSupport.HttpBuilder`	`redirect(Class<T> controllerClass, Map params)` Redirects to a controller, generates appropriate redirect path.
`protected <T extends AppController> HttpSupport.HttpBuilder`	`redirect(Class<T> controllerClass, Object id)` Convenience method for `redirect(Class, java.util.Map)`.
`protected <T extends AppController> HttpSupport.HttpBuilder`	`redirect(Class<T> controllerClass, String action)` Convenience method for `redirect(Class, java.util.Map)`.
`protected <T extends AppController> HttpSupport.HttpBuilder`	`redirect(Class<T> controllerClass, String action, Object id)` Convenience method for `redirect(Class, java.util.Map)`.
`protected HttpSupport.HttpBuilder`	`redirect(String path)` Redirects to a an action of this controller, or an action of a different controller.
`protected HttpSupport.HttpBuilder`	`redirect(URL url)` Redirects to another URL (usually another site).
`protected HttpSupport.HttpBuilder`	`redirectToReferrer()` Redirects to referrer if one exists.
`protected HttpSupport.HttpBuilder`	`redirectToReferrer(String defaultReference)` Redirects to referrer if one exists.
`protected String`	`remoteAddress()` IP address of the requesting client.
`protected String`	`remoteHost()` Host name of the requesting client.
`protected HttpSupport.RenderBuilder`	`render(String template, Map values)` Renders results with a template.
`protected boolean`	`requestHas(String name)` Synonym of `exists(String)`.
`protected HttpSupport.HttpBuilder`	`respond(String text)` This method will send the text to a client verbatim.
`protected String`	`sanitize(String unsafeContent)` Cleans HTML from harmful tags, making XSS impossible.
`void`	`sendCookie(Cookie cookie)` Sends cookie to browse with response.
`void`	`sendCookie(String name, String value)` Sends cookie to browse with response.
`protected HttpSupport.HttpBuilder`	`sendFile(File file)` Convenience method for downloading files.
`protected HttpSupport.HttpBuilder`	`sendFile(File file, boolean delete)` Convenience method for downloading files.
`void`	`sendPermanentCookie(String name, String value)` Sends long to live cookie to browse with response.
`protected SessionFacade`	`session()` Returns reference to a current session.
`protected Object`	`session(String name)` Synonym of `sessionObject(String)`.
`protected void`	`session(String name, Serializable value)` Convenience method, sets an object on a session.
`protected Boolean`	`sessionBoolean(String name)` Convenience method, returns object from session, equivalent of:
`protected Double`	`sessionDouble(String name)` Convenience method, returns object from session, equivalent of:
`protected Float`	`sessionFloat(String name)` Convenience method, returns object from session, equivalent of:
`protected boolean`	`sessionHas(String name)` Returns true if session has named object, false if not.
`protected Integer`	`sessionInteger(String name)` Convenience method, returns object from session, equivalent of:
`protected Long`	`sessionLong(String name)` Convenience method, returns object from session, equivalent of:
`protected Object`	`sessionObject(String name)` Convenience method, returns object from session, equivalent of:
`protected String`	`sessionString(String name)` Convenience method, returns object from session, equivalent of:
`protected void`	`setContentLength(int length)` Sets content length of response.
`protected void`	`setEncoding(String encoding)` Sets character encoding on the response.
`protected void`	`setLocale(Locale locale)` Sets locale on response.
`protected void`	`setRequestEncoding(String encoding)` Sets character encoding for request.
`protected void`	`setResponseEncoding(String encoding)` Sets character encoding for response.
`protected int`	`status()` Returns status code from current response.
`protected HttpSupport.HttpBuilder`	`streamOut(InputStream in)` Streams content of the `reader` to the HTTP client.
`protected Iterator<FormItem>`	`uploadedFiles()` Returns a collection of uploaded files from a multi-part port request.
`protected Iterator<FormItem>`	`uploadedFiles(String encoding)` Returns a collection of uploaded files from a multi-part port request.
`protected Iterator<FormItem>`	`uploadedFiles(String encoding, long maxFileSize)` Returns a collection of uploaded files from a multi-part port request.
`protected String`	`uri()` Returns URI, or a full path of request.
`protected String`	`url()` Returns a full URL of the request, all except a query string.
`protected String`	`userAgent()` Helper method, returns user-agent header of the request.
`protected Map`	`values()` Returns a mutable Map with all the values from the current request context.
`protected void`	`view(Map values)` Convenience method, calls `assign(String, Object)` internally.
`protected void`	`view(Object... values)` Convenience method to pass multiple names and corresponding values to a view.
`protected void`	`view(String name, Object value)` Alias to `assign(String, Object)`.
`protected PrintWriter`	`writer()` Produces a writer for sending raw data to HTTP clients.
`protected PrintWriter`	`writer(String contentType, Map headers, int status)` Produces a writer for sending raw data to HTTP clients.
`protected 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
  - HttpSupport
```
public HttpSupport()
```
- Method Detail
  - logInfo
```
protected void logInfo(String info)
```
  - logDebug
```
protected void logDebug(String info)
```
  - logWarning
```
protected void logWarning(String info)
```
  - logWarning
```
protected void logWarning(String info,
                          Throwable e)
```
  - logError
```
protected void logError(String info)
```
  - logError
```
protected void logError(Throwable e)
```
  - logError
```
protected void logError(String info,
                        Throwable e)
```
  - assign
```
protected void assign(String name,
                      Object value)
```
    Assigns a value for a view.
    
    Parameters:
    
    name - name of value
    
    value - value.
  - view
```
protected void view(String name,
                    Object value)
```
    Alias to assign(String, Object).
    
    Parameters:
    
    name - name of object to be passed to view
    
    value - object to be passed to view
  - status
```
protected int status()
```
    Returns status code from current response.
    
    Returns:
    
    status code or -1 if controller response was not generated (error)
  - view
```
protected void view(Map values)
```
    Convenience method, calls assign(String, Object) internally. The keys in teh map are converted to String values.
    
    Parameters:
    
    values - map with values to pass to view.
  - view
```
protected void view(Object... values)
```
    Convenience method to pass multiple names and corresponding values to a view.
    
    Parameters:
    
    values - - pairs of names and values. such as: name1, value1, name2, value2, etc. Number of arguments must be even.
  - flash
```
protected void flash(Map values)
```
    Flash method to display multiple flash messages. Takes in a map of names and values for a flash. Keys act like names, and values act like... ehr.. values.
    
    Parameters:
    
    values - values to flash.
    
    See Also:
    
    flash(String, Object)
  - flash
```
protected void flash(Object... values)
```
    Flash method to display multiple flash messages. Takes in a vararg of values for flash. Number of arguments must be even. Format: name, value, name, value, etc.
    
    Parameters:
    
    values - values to flash.
    
    See Also:
    
    flash(String, Object)
  - flash
```
protected void flash(String name)
```
    Sets a flash name for a flash with a body. Here is a how to use a tag with a body:
```
 <@flash name="warning">
         <div class="warning">${message}</div>
       </@flash>
 
```
    If body refers to variables (as in this example), then such variables need to be passed in to the template as usual using the view(String, Object) method.
    Parameters:
    
    name - name of a flash
  - flash
```
protected void flash(String name,
                     Object value)
```
    Sends value to flash. Flash survives one more request. Using flash is typical for POST/GET pattern,
    
    Parameters:
    
    name - name of value to flash
    
    value - value to live for one more request in current session.
  - render
```
protected HttpSupport.RenderBuilder render(String template,
                                           Map values)
```
    Renders results with a template. This call must be the last call in the action.
    
    Parameters:
    
    template - - template name, must be "absolute", starting with slash, such as: "/controller_dir/action_template".
    
    values - map with values to pass to view.
    
    Returns:
    
    instance of HttpSupport.RenderBuilder, which is used to provide additional parameters.
  - redirect
```
protected HttpSupport.HttpBuilder redirect(String path)
```
    Redirects to a an action of this controller, or an action of a different controller. This method does not expect a full URL.
    
    Parameters:
    
    path - - expected to be a path within the application.
    
    Returns:
    
    instance of HttpSupport.HttpBuilder to accept additional information.
  - redirect
```
protected HttpSupport.HttpBuilder redirect(URL url)
```
    Redirects to another URL (usually another site).
    
    Parameters:
    
    url - absolute URL: http://domain/path....
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirectToReferrer
```
protected HttpSupport.HttpBuilder redirectToReferrer(String defaultReference)
```
    Redirects to referrer if one exists. If a referrer does not exist, it will be redirected to the defaultReference.
    
    Parameters:
    
    defaultReference - where to redirect - can be absolute or relative; this will be used in case the request does not provide a "Referrer" header.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirectToReferrer
```
protected HttpSupport.HttpBuilder redirectToReferrer()
```
    Redirects to referrer if one exists. If a referrer does not exist, it will be redirected to the root of the application.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirect
```
protected <T extends AppController> HttpSupport.HttpBuilder redirect(Class<T> controllerClass,
                                                                     String action,
                                                                     Object id)
```
    Convenience method for redirect(Class, java.util.Map).
    
    Parameters:
    
    controllerClass - controller class where to send redirect.
    
    action - action to redirect to.
    
    id - id to redirect to.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirect
```
protected <T extends AppController> HttpSupport.HttpBuilder redirect(Class<T> controllerClass,
                                                                     Object id)
```
    Convenience method for redirect(Class, java.util.Map).
    
    Parameters:
    
    controllerClass - controller class where to send redirect.
    
    id - id to redirect to.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirect
```
protected <T extends AppController> HttpSupport.HttpBuilder redirect(Class<T> controllerClass,
                                                                     String action)
```
    Convenience method for redirect(Class, java.util.Map).
    
    Parameters:
    
    controllerClass - controller class where to send redirect.
    
    action - action to redirect to.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirect
```
protected HttpSupport.HttpBuilder redirect()
```
    Redirects to the same controller, and action "index". This is equivalent to
```
     redirect(BooksController.class);
 
```
    given that the current controller is BooksController.
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirect
```
protected <T extends AppController> HttpSupport.HttpBuilder redirect(Class<T> controllerClass)
```
    Redirects to given controller, action "index" without any parameters.
    
    Parameters:
    
    controllerClass - controller class where to send redirect.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - redirect
```
protected <T extends AppController> HttpSupport.HttpBuilder redirect(Class<T> controllerClass,
                                                                     Map params)
```
    Redirects to a controller, generates appropriate redirect path. There are two keyword keys expected in the params map: "action" and "id". Both are optional. This method will generate appropriate URLs for regular as well as RESTful controllers. The "action" and "id" values in the map will be treated as parts of URI such as:
```
 
 /controller/action/id
 
 
```
    for regular controllers, and:
```
 
 /controller/id/action
 
 
```
    for RESTful controllers. For RESTful controllers, the action names are limited to those described in RESTful and allowed on a GET URLs, which are: "edit_form" and "new_form".
    The map may contain any number of other key/value pairs, which will be converted to a query string for the redirect URI. Example:
    Method:
```
 
 redirect(app.controllers.PersonController.class,  org.javalite.common.Collections.map("action", "show", "id", 123, "format", "json", "restrict", "true"));
 
 
```
    will generate the following URI:
```
 
 /person/show/123?format=json&restrict=true
 
 
```
    This method will also perform URL - encoding of special characters if necessary.
    Parameters:
    
    controllerClass - controller class
    
    params - map with request parameters.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - respond
```
protected HttpSupport.HttpBuilder respond(String text)
```
    This method will send the text to a client verbatim. It will not use any layouts. Use it to build app.services and to support AJAX.
    
    Parameters:
    
    text - text of response.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - sendFile
```
protected HttpSupport.HttpBuilder sendFile(File file,
                                           boolean delete)
                                    throws FileNotFoundException
```
    Convenience method for downloading files. This method will force the browser to find a handler(external program) for this file (content type) and will provide a name of file to the browser. This method sets an HTTP header "Content-Disposition" based on a file name.
    
    Parameters:
    
    file - file to download.
    
    delete - true to delete the file after processing
    
    Returns:
    
    builder instance.
    
    Throws:
    
    FileNotFoundException - thrown if file not found.
  - sendFile
```
protected HttpSupport.HttpBuilder sendFile(File file)
                                    throws FileNotFoundException
```
    Convenience method for downloading files. This method will force the browser to find a handler(external program) for this file (content type) and will provide a name of file to the browser. This method sets an HTTP header "Content-Disposition" based on a file name.
    
    Parameters:
    
    file - file to download.
    
    Returns:
    
    builder instance.
    
    Throws:
    
    FileNotFoundException - thrown if file not found.
  - getFile
```
protected FileItem getFile(String fieldName,
                           List<FormItem> formItems)
```
    Convenience method to get file content from multipart/form-data request. If more than one files with the same name are submitted, only one is returned.
    
    Parameters:
    
    fieldName - name of form field from the multipart/form-data request corresponding to the uploaded file.
    
    formItems - form items retrieved from multipart/form-data request.
    
    Returns:
    
    InputStream from which to read content of uploaded file or null if FileItem with this name is not found.
  - param
```
protected String param(String name)
```
    Returns value of one named parameter from request. If this name represents multiple values, this call will result in IllegalArgumentException.
    
    Parameters:
    
    name - name of parameter.
    
    Returns:
    
    value of request parameter.
    
    See Also:
    
    RequestUtils.param(String)
  - param
```
protected String param(String name,
                       List<FormItem> formItems)
```
    Convenience method to get a parameter in case multipart/form-data request was used. Returns value of one named parameter from request. If this name represents multiple values, this call will result in IllegalArgumentException.
    
    Parameters:
    
    name - name of parameter.
    
    formItems - form items retrieved from multipart/form-data request.
    
    Returns:
    
    value of request parameter.
    
    See Also:
    
    RequestUtils.param(String)
  - exists
```
protected 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
```
protected 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
```
protected String host()
```
    Returns local host name on which request was received.
    
    Returns:
    
    local host name on which request was received.
  - ipAddress
```
protected String ipAddress()
```
    Returns local IP address on which request was received.
    
    Returns:
    
    local IP address on which request was received.
  - getRequestProtocol
```
protected 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
```
protected 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.
  - getHttpServletRequest
```
protected javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
    Direct access to current HttpServletRequest for low level operations.
    
    Returns:
    
    instance of current HttpServletRequest.
  - getHttpServletResponse
```
protected javax.servlet.http.HttpServletResponse getHttpServletResponse()
```
    Direct access to current HttpServletResponse for low level operations.
    
    Returns:
    
    instance of current HttpServletResponse.
  - port
```
protected 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
```
protected String protocol()
```
    Returns protocol of request, for example: HTTP/1.1.
    
    Returns:
    
    protocol of request
  - getRequestHost
```
protected 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
```
protected String ipForwardedFor()
```
    Returns IP address that the web server forwarded request for.
    
    Returns:
    
    IP address that the web server forwarded request for.
  - getId
```
protected 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.
  - uploadedFiles
```
protected Iterator<FormItem> uploadedFiles()
```
    Returns a collection of uploaded files from a multi-part port request. Uses request encoding if one provided, and sets no limit on the size of upload.
    
    Returns:
    
    a collection of uploaded files from a multi-part port request.
  - uploadedFiles
```
protected Iterator<FormItem> uploadedFiles(String encoding)
```
    Returns a collection of uploaded files from a multi-part port request. Sets no limit on the size of upload.
    
    Parameters:
    
    encoding - specifies the character encoding to be used when reading the headers of individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
    
    Returns:
    
    a collection of uploaded files from a multi-part port request.
  - uploadedFiles
```
protected Iterator<FormItem> uploadedFiles(String encoding,
                                           long maxFileSize)
```
    Returns a collection of uploaded files from a multi-part port request.
    
    Parameters:
    
    encoding - specifies the character encoding to be used when reading the headers of individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
    
    maxFileSize - maximum file size in the upload in bytes. -1 indicates no limit.
    
    Returns:
    
    a collection of uploaded files from a multi-part port request.
  - multipartFormItems
```
protected List<FormItem> multipartFormItems()
```
    Convenience method, calls multipartFormItems(String). Does not set encoding before reading request.
    
    Returns:
    
    a collection of uploaded files/fields from a multi-part request.
    
    See Also:
    
    multipartFormItems(String)
  - multipartFormItems
```
protected List<FormItem> multipartFormItems(String encoding)
```
    Returns a collection of uploaded files and form fields from a multi-part request. This method uses DiskFileItemFactory. As a result, it is recommended to add the following to your web.xml file:
```
   <listener>
      <listener-class>
         org.apache.commons.fileupload.servlet.FileCleanerCleanup
      </listener-class>
   </listener>
```
    For more information, see: Using FileUpload The size of upload defaults to max of 20mb. Files greater than that will be rejected. If you want to accept larger files, create a file called activeweb.properties, add it to your classpath and place this property to the file:
```
 #max upload size
 maxUploadSize = 20000000
 
```
    Alternatively, just call this method and pass a per-request parameter for the size: multipartFormItems(String, long).
    Parameters:
    
    encoding - specifies the character encoding to be used when reading the headers of individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
    
    Returns:
    
    a collection of uploaded files from a multi-part request.
  - multipartFormItems
```
protected List<FormItem> multipartFormItems(String encoding,
                                            long maxUploadSize)
```
    Returns a collection of uploaded files and form fields from a multi-part request. This method uses DiskFileItemFactory. As a result, it is recommended to add the following to your web.xml file:
```
   <listener>
      <listener-class>
         org.apache.commons.fileupload.servlet.FileCleanerCleanup
      </listener-class>
   </listener>
```
    For more information, see: Using FileUpload
    Parameters:
    
    encoding - specifies the character encoding to be used when reading the headers of individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
    
    maxUploadSize - maximum size of the upload in bytes. A value of -1 indicates no maximum.
    
    Returns:
    
    a collection of uploaded files from a multi-part request.
  - params
```
protected 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
```
protected 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.
  - params
```
protected List<String> params(String name,
                              List<FormItem> formItems)
```
    Convenience method to get parameters 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.
  - getMap
```
public Map<String,String> getMap(String hashName)
```
    Returns a map parsed from a request if parameter names have a "hash" syntax:
```
  <input type="text" name="account[name]" />
        <input type="text" name="account[number]" />
 
```
    will result in a map where keys are names of hash elements, and values are values of these elements from request. For the example above, the map will have these values:
```
     { "name":"John", "number": "123" }
 
```
    Parameters:
    
    hashName - - name of a hash. In the example above, it will be "account".
    
    Returns:
    
    map with name/value pairs parsed from request.
  - getMap
```
public Map<String,String> getMap(String hashName,
                                 List<FormItem> formItems)
```
    Convenience method to get parameter map in case multipart/form-data request was used. This method will skip files, and will only return form fields that are not files. Returns a map parsed from a request if parameter names have a "hash" syntax:
```
  <input type="text" name="account[name]" />
  <input type="text" name="account[number]" />
 
```
    will result in a map where keys are names of hash elements, and values are values of these elements from request. For the example above, the map will have these values:
```
     { "name":"John", "number": "123" }
 
```
    Parameters:
    
    hashName - - name of a hash. In the example above, it will be "account".
    
    formItems - form items retrieved from multipart/form-data request.
    
    Returns:
    
    map with name/value pairs parsed from request.
  - setRequestEncoding
```
protected void setRequestEncoding(String encoding)
                           throws UnsupportedEncodingException
```
    Sets character encoding for request. Has to be called before reading any parameters of getting input stream.
    
    Parameters:
    
    encoding - encoding to be set.
    
    Throws:
    
    UnsupportedEncodingException
  - setResponseEncoding
```
protected void setResponseEncoding(String encoding)
```
    Sets character encoding for response.
    
    Parameters:
    
    encoding - encoding to be set.
  - setEncoding
```
protected void setEncoding(String encoding)
```
    Sets character encoding on the response.
    
    Parameters:
    
    encoding - character encoding for response.
  - encoding
```
protected void encoding(String encoding)
```
    Synonym for setEncoding(String)
    
    Parameters:
    
    encoding - encoding of response to client
  - getEncoding
```
protected String getEncoding()
```
    Controllers can override this method to return encoding they require. Encoding set in method setEncoding(String) trumps this setting.
    
    Returns:
    
    null. If this method is not overridden and encoding is not set from an action or filter, encoding will be set according to container implementation.
  - setContentLength
```
protected void setContentLength(int length)
```
    Sets content length of response.
    
    Parameters:
    
    length - content length of response.
  - setLocale
```
protected void setLocale(Locale locale)
```
    Sets locale on response.
    
    Parameters:
    
    locale - locale for response.
  - locale
```
protected void locale(Locale locale)
```
    Same as setLocale(java.util.Locale)
    
    Parameters:
    
    locale - locale for response
  - locale
```
protected Locale locale()
```
    Returns locale of request.
    
    Returns:
    
    locale of request.
  - getLocale
```
protected Locale getLocale()
```
    Same as locale().
    
    Returns:
    
    locale of request.
  - params1st
```
protected Map<String,String> params1st()
```
    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.
    
    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
```
protected Map<String,String> params1st(List<FormItem> formItems)
```
    Convenience method to get first parameter values in case multipart/form-data request was used. 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.
    
    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.
  - session
```
protected SessionFacade session()
```
    Returns reference to a current session. Creates a new session of one does not exist.
    
    Returns:
    
    reference to a current session.
  - session
```
protected void session(String name,
                       Serializable value)
```
    Convenience method, sets an object on a session. Equivalent of:
```
 
     session().put(name, value)
 
 
```
    Parameters:
    
    name - name of object
    
    value - object itself.
  - sessionObject
```
protected Object sessionObject(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     session().get(name)
 
 
```
    Parameters:
    
    name - name of object,
    
    Returns:
    
    session object.
  - session
```
protected Object session(String name)
```
    Synonym of sessionObject(String).
    
    Parameters:
    
    name - name of session attribute
    
    Returns:
    
    value of session attribute of null if not found
  - sessionString
```
protected String sessionString(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     String val = (String)session().get(name)
 
 
```
    Parameters:
    
    name - name of object
    
    Returns:
    
    value
  - sessionInteger
```
protected Integer sessionInteger(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     Integer val = (Integer)session().get(name)
 
 
```
    Parameters:
    
    name - name of object
    
    Returns:
    
    value
  - sessionBoolean
```
protected Boolean sessionBoolean(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     Boolean val = (Boolean)session().get(name)
 
 
```
    Parameters:
    
    name - name of object
    
    Returns:
    
    value
  - sessionDouble
```
protected Double sessionDouble(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     Double val = (Double)session().get(name)
 
 
```
    Parameters:
    
    name - name of object
    
    Returns:
    
    value
  - sessionFloat
```
protected Float sessionFloat(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     Float val = (Float)session().get(name)
 
 
```
    Parameters:
    
    name - name of object
    
    Returns:
    
    value
  - sessionLong
```
protected Long sessionLong(String name)
```
    Convenience method, returns object from session, equivalent of:
```
 
     Long val = (Long)session().get(name)
 
 
```
    Parameters:
    
    name - name of object
    
    Returns:
    
    value
  - sessionHas
```
protected boolean sessionHas(String name)
```
    Returns true if session has named object, false if not.
    
    Parameters:
    
    name - name of object.
    
    Returns:
    
    true if session has named object, false if not.
  - cookies
```
public List<Cookie> cookies()
```
    Returns collection of all cookies browser sent.
    
    Returns:
    
    collection of all cookies browser sent.
  - cookie
```
public 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
```
protected String cookieValue(String name)
```
    Convenience method, returns cookie value.
    
    Parameters:
    
    name - name of cookie.
    
    Returns:
    
    cookie value.
  - sendCookie
```
public void sendCookie(Cookie cookie)
```
    Sends cookie to browse with response.
    
    Parameters:
    
    cookie - cookie to send.
  - sendCookie
```
public void sendCookie(String name,
                       String value)
```
    Sends cookie to browse with response.
    
    Parameters:
    
    name - name of cookie
    
    value - value of cookie.
  - sendPermanentCookie
```
public void sendPermanentCookie(String name,
                                String value)
```
    Sends long to live cookie to browse with response. This cookie will be asked to live for 20 years.
    
    Parameters:
    
    name - name of cookie
    
    value - value of cookie.
  - path
```
protected 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
```
protected 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
```
protected String queryString()
```
    Returns query string of the request.
    
    Returns:
    
    query string of the request.
  - method
```
protected String method()
```
    Returns an HTTP method from the request.
    
    Returns:
    
    an HTTP method from the request.
  - isGet
```
protected boolean isGet()
```
    True if this request uses HTTP GET method, false otherwise.
    
    Returns:
    
    True if this request uses HTTP GET method, false otherwise.
  - isPost
```
protected boolean isPost()
```
    True if this request uses HTTP POST method, false otherwise.
    
    Returns:
    
    True if this request uses HTTP POST method, false otherwise.
  - isPut
```
protected boolean isPut()
```
    True if this request uses HTTP PUT method, false otherwise.
    
    Returns:
    
    True if this request uses HTTP PUT method, false otherwise.
  - isDelete
```
protected boolean isDelete()
```
    True if this request uses HTTP DELETE method, false otherwise.
    
    Returns:
    
    True if this request uses HTTP DELETE method, false otherwise.
  - isHead
```
protected boolean isHead()
```
    True if this request uses HTTP HEAD method, false otherwise.
    
    Returns:
    
    True if this request uses HTTP HEAD method, false otherwise.
  - context
```
protected 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
```
protected 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
```
protected String remoteHost()
```
    Host name of the requesting client.
    
    Returns:
    
    host name of the requesting client.
  - remoteAddress
```
protected String remoteAddress()
```
    IP address of the requesting client.
    
    Returns:
    
    IP address of the requesting client.
  - header
```
protected String header(String name)
```
    Returns a request header by name.
    
    Parameters:
    
    name - name of header
    
    Returns:
    
    header value.
  - headers
```
protected Map<String,String> headers()
```
    Returns all headers from a request keyed by header name.
    
    Returns:
    
    all headers from a request keyed by header name.
  - header
```
protected void header(String name,
                      String value)
```
    Adds a header to response.
    
    Parameters:
    
    name - name of header.
    
    value - value of header.
  - header
```
protected void header(String name,
                      Object value)
```
    Adds a header to response.
    
    Parameters:
    
    name - name of header.
    
    value - value of header.
  - streamOut
```
protected HttpSupport.HttpBuilder streamOut(InputStream in)
```
    Streams content of the reader to the HTTP client.
    
    Parameters:
    
    in - input stream to read bytes from.
    
    Returns:
    
    HttpSupport.HttpBuilder, to accept additional information.
  - getRealPath
```
protected String getRealPath(String path)
```
    Returns a String containing the real path for a given virtual path. For example, the path "/index.html" returns the absolute file path on the server's filesystem would be served by a request for "http://host/contextPath/index.html", where contextPath is the context path of this ServletContext..
    The real path returned will be in a form appropriate to the computer and operating system on which the servlet
    container is running, including the proper path separators. This method returns null if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a .war archive).
    JavaDoc copied from: http://download.oracle.com/javaee/1.3/api/javax/servlet/ServletContext.html#getRealPath%28java.lang.String%29
    
    Parameters:
    
    path - a String specifying a virtual path
    
    Returns:
    
    a String specifying the real path, or null if the translation cannot be performed
  - outputStream
```
protected OutputStream outputStream()
```
    Use to send raw data to HTTP client. Content type and headers will not be set. Response code will be set to 200.
    
    Returns:
    
    instance of output stream to send raw data directly to HTTP client.
  - outputStream
```
protected OutputStream outputStream(String contentType)
```
    Use to send raw data to HTTP client. Status will be set to 200.
    
    Parameters:
    
    contentType - content type
    
    Returns:
    
    instance of output stream to send raw data directly to HTTP client.
  - outputStream
```
protected OutputStream outputStream(String contentType,
                                    Map headers,
                                    int status)
```
    Use to send raw data to HTTP client.
    
    Parameters:
    
    contentType - content type
    
    headers - set of headers.
    
    status - status.
    
    Returns:
    
    instance of output stream to send raw data directly to HTTP client.
  - writer
```
protected PrintWriter writer()
```
    Produces a writer for sending raw data to HTTP clients. Content type content type not be set on the response. Headers will not be send to client. Status will be set to 200.
    
    Returns:
    
    instance of a writer for writing content to HTTP client.
  - writer
```
protected PrintWriter writer(String contentType,
                             Map headers,
                             int status)
```
    Produces a writer for sending raw data to HTTP clients.
    
    Parameters:
    
    contentType - content type. If null - will not be set on the response
    
    headers - headers. If null - will not be set on the response
    
    status - will be sent to browser.
    
    Returns:
    
    instance of a writer for writing content to HTTP client.
  - blank
```
protected boolean blank(String... names)
```
    Returns true if any named request parameter is blank.
    
    Parameters:
    
    names - names of request parameters.
    
    Returns:
    
    true if any request parameter is blank.
  - isXhr
```
protected boolean isXhr()
```
    Returns true if this request is Ajax.
    
    Returns:
    
    true if this request is Ajax.
  - userAgent
```
protected String userAgent()
```
    Helper method, returns user-agent header of the request.
    
    Returns:
    
    user-agent header of the request.
  - xhr
```
protected boolean xhr()
```
    Synonym for isXhr().
  - appContext
```
protected AppContext appContext()
```
    Returns instance of AppContext.
    
    Returns:
    
    instance of AppContext.
  - format
```
protected 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.
  - getRoute
```
protected Route getRoute()
```
    Returns instance of Route to be used for potential conditional logic inside controller filters.
    
    Returns:
    
    instance of Route
  - merge
```
protected String merge(String template,
                       Map values)
```
    Will merge a template and return resulting string. This method is used for just merging some text with dynamic values. Once you have the result, you can send it by email, external web service, save it to a database, etc.
    
    Parameters:
    
    template - name of template - same as in regular templates. Example: "/email-templates/welcome".
    
    values - values to be merged into template.
    
    Returns:
    
    merged string
  - getResponseHeaders
```
public Map<String,String> getResponseHeaders()
```
    Returns response headers
    
    Returns:
    
    map with response headers.
  - sanitize
```
protected String sanitize(String unsafeContent)
```
    Cleans HTML from harmful tags, making XSS impossible.
    For example, input like this:
```
      <html><script> alert('hello');</script><div>this is a clean part</div></html>
 
```
    Will produce output like this:
```
     this is a clean part
 
```
    Parameters:
    
    unsafeContent - unsafe content. Something that an end user typed into a text area, or input that may include a script tag or other garbage.
    
    Returns:
    
    sanitized version of input
  - getRequestInputStream
```
protected InputStream getRequestInputStream()
                                     throws IOException
```
    Returns InputStream of the request.
    
    Returns:
    
    InputStream of the request
    
    Throws:
    
    IOException
  - getRequestStream
```
protected InputStream getRequestStream()
                                throws IOException
```
    Alias to getRequestInputStream().
    
    Returns:
    
    input stream to read data sent by client.
    
    Throws:
    
    IOException
  - getRequestString
```
protected String getRequestString()
                           throws IOException
```
    Reads entire request data as String. Do not use for large data sets to avoid memory issues, instead use getRequestInputStream().
    
    Returns:
    
    data sent by client as string.
    
    Throws:
    
    IOException
  - getRequestBytes
```
protected byte[] getRequestBytes()
                          throws IOException
```
    Reads entire request data as byte array. Do not use for large data sets to avoid memory issues.
    
    Returns:
    
    data sent by client as string.
    
    Throws:
    
    IOException
  - jsonList
```
protected List jsonList()
```
    Converts posted JSON array to a Java List. Example of a JSON array: [1, 2, 3].
    
    Returns:
    
    Java List converted from posted JSON string.
  - jsonMap
```
protected Map jsonMap()
```
    Converts posted JSON map to a Java Map. Example JSON map: {"name":"John", "age":21}.
    
    Returns:
    
    Java Map converted from posted JSON string map.
  - jsonMaps
```
protected Map[] jsonMaps()
```
    Converts posted JSON maps to a Java Maps array. Example JSON map: [{"name":"John", "age":21}, {"name":"Jane", "age":20}].
    
    Returns:
    
    Java Maps converted from posted JSON string maps.
  - values
```
protected Map values()
```
    Returns a mutable Map with all the values from the current request context. Use this to get/put/modify values from current place on the stack down stream (from filters to controllers, to views).
    
    Returns:
    
    a mutable Map with all values from/for current request context.

Class HttpSupport

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpSupport

Method Detail

logInfo

logDebug

logWarning

logWarning

logError

logError

logError

assign

view

status

view

view

flash

flash

flash

flash

render

redirect

redirect

redirectToReferrer

redirectToReferrer

redirect

redirect

redirect

redirect

redirect

redirect

respond

sendFile

sendFile

getFile

param

param

exists

requestHas

host

ipAddress

getRequestProtocol

getRequestPort

getHttpServletRequest

getHttpServletResponse

port

protocol

getRequestHost

ipForwardedFor

getId

uploadedFiles

uploadedFiles

uploadedFiles

multipartFormItems

multipartFormItems

multipartFormItems

params

params

params

getMap

getMap

setRequestEncoding

setResponseEncoding

setEncoding

encoding

getEncoding

setContentLength

setLocale

locale

locale

getLocale

params1st

params1st

session

session

sessionObject