Request (Java Express 0.0.10 API)

java.lang.Object
- express.http.request.Request

```
public class Request
extends Object
```
Author:

Simon Reinisch
Class encapsulating HTTP request data

Constructor Summary

Constructors
Constructor and Description

Request(com.sun.net.httpserver.HttpExchange exchange, Express express)

Constructors
Constructor and Description
`Request(com.sun.net.httpserver.HttpExchange exchange, Express express)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMiddlewareContent(Filter middleware, Object middlewareData)` Add a the content from a middleware
`InetAddress`	`getAddress()` Returns the InetAddress from the client.
`Express`	`getApp()`
`List<Authorization>`	`getAuthorization()`
`InputStream`	`getBody()`
`long`	`getContentLength()` Returns the to long parsed content-length.
`String`	`getContentType()`
`String`	`getContext()` Returns the corresponding context.
`Cookie`	`getCookie(String name)` Get a request cookie by name.
`HashMap<String,Cookie>`	`getCookies()` Return all cookies from this request.
`String`	`getFormQuery(String name)` Returns a query from a form which uses the 'application/x-www-form-urlencoded' request header.
`HashMap<String,String>`	`getFormQuerys()` Returns all query's from an x-www-form-urlencoded body.
`List<String>`	`getHeader(String header)` Returns an header value.
`String`	`getHost()`
`String`	`getIp()` Returns the IP-Address from the client.
`String`	`getMethod()`
`Object`	`getMiddlewareContent(String name)` Get the data from a specific middleware by name (Also the reason why the interface ExpressFilter implements a getName())
`String`	`getParam(String param)` Returns an param from a dynamic url.
`HashMap<String,String>`	`getParams()` Returns all params from the url.
`String`	`getPath()`
`String`	`getProtocol()` The connection protocol HTTP/1.0, HTTP/1.1 etc.
`String`	`getQuery(String name)` Returns the value from the url-query.
`HashMap<String,String>`	`getQuerys()` Return all url-query's.
`URI`	`getURI()`
`String`	`getUserAgent()`
`boolean`	`hasAuthorization()`
`boolean`	`isFresh()` Checks if the connection is 'fresh' It is true if the cache-control request header doesn't have a no-cache directive, the if-modified-since request header is specified and last-modified request header is equal to or earlier than the modified response header or if-none-match request header is *.
`boolean`	`isSecure()` Returns whenever the connection is over HTTPS.
`boolean`	`isStale()` Indicates whether the request is "stale" and is the opposite of req.fresh
`boolean`	`isXHR()` Returns true if the 'X-Requested-With' header field is 'XMLHttpRequest'.
`void`	`pipe(OutputStream os, int bufferSize)` Pipe the body from this request to an OutputStream.
`void`	`pipe(Path f, int bufferSize)` Pipe the body from this request to an file.
`void`	`setContext(String context)` Set the corresponding context.
`void`	`setParams(HashMap<String,String> params)` Set the params.

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

- Constructor Detail
  - Request
```
public Request(com.sun.net.httpserver.HttpExchange exchange,
               Express express)
```
- Method Detail
  - getBody
```
public InputStream getBody()
```
    Returns:
    
    The request body as InputStream
  - pipe
```
public void pipe(OutputStream os,
                 int bufferSize)
          throws IOException
```
    Pipe the body from this request to an OutputStream.
    
    Parameters:
    
    os - The OutputStream.
    
    bufferSize - Buffer-size, eg. 4096.
    
    Throws:
    
    IOException - If an IO-Error occurs.
  - pipe
```
public void pipe(Path f,
                 int bufferSize)
          throws IOException
```
    Pipe the body from this request to an file. If the file not exists, it will be created.
    
    Parameters:
    
    f - The target file
    
    bufferSize - Buffer-size, eg. 4096.
    
    Throws:
    
    IOException - If an IO-Error occurs.
  - getCookie
```
public Cookie getCookie(String name)
```
    Get a request cookie by name.
    
    Parameters:
    
    name - The cookie name.
    
    Returns:
    
    The cookie, null if there is no cookie with this name.
  - getCookies
```
public HashMap<String,Cookie> getCookies()
```
    Return all cookies from this request.
    
    Returns:
    
    All cookies.
  - addMiddlewareContent
```
public void addMiddlewareContent(Filter middleware,
                                 Object middlewareData)
```
    Add a the content from a middleware
    
    Parameters:
    
    middleware - The middleware
    
    middlewareData - The data from the middleware
  - getMiddlewareContent
```
public Object getMiddlewareContent(String name)
```
    Get the data from a specific middleware by name (Also the reason why the interface ExpressFilter implements a getName())
    
    Parameters:
    
    name - The middleware name
    
    Returns:
    
    The middleware object
  - getUserAgent
```
public String getUserAgent()
```
    Returns:
    
    The request user-agent.
  - getHost
```
public String getHost()
```
    Returns:
    
    The request host.
  - getAddress
```
public InetAddress getAddress()
```
    Returns the InetAddress from the client.
    
    Returns:
    
    The InetAddress.
  - getIp
```
public String getIp()
```
    Returns the IP-Address from the client.
    
    Returns:
    
    The IP-Address.
  - getContentType
```
public String getContentType()
```
    Returns:
    
    The request content-type.
  - getContentLength
```
public long getContentLength()
```
    Returns the to long parsed content-length.
    
    Returns:
    
    The content-length, -1 if the header was invalid.
  - getPath
```
public String getPath()
```
    Returns:
    
    The request path.
  - getURI
```
public URI getURI()
```
    Returns:
    
    The original request uri.
  - getMethod
```
public String getMethod()
```
    Returns:
    
    The request-method.
  - isFresh
```
public boolean isFresh()
```
    Checks if the connection is 'fresh' It is true if the cache-control request header doesn't have a no-cache directive, the if-modified-since request header is specified and last-modified request header is equal to or earlier than the modified response header or if-none-match request header is *.
    
    Returns:
    
    True if the connection is fresh, false otherwise.
  - isStale
```
public boolean isStale()
```
    Indicates whether the request is "stale" and is the opposite of req.fresh
    
    Returns:
    
    The opposite of req.fresh;
  - isSecure
```
public boolean isSecure()
```
    Returns whenever the connection is over HTTPS.
    
    Returns:
    
    True when the connection is over HTTPS, false otherwise.
  - isXHR
```
public boolean isXHR()
```
    Returns true if the 'X-Requested-With' header field is 'XMLHttpRequest'. Indicating that the request was made by a client library such as jQuery.
    
    Returns:
    
    True if the 'X-Requested-With' header field is 'XMLHttpRequest'.
  - getProtocol
```
public String getProtocol()
```
    The connection protocol HTTP/1.0, HTTP/1.1 etc.
    
    Returns:
    
    The connection protocol.
  - getAuthorization
```
public List<Authorization> getAuthorization()
```
    Returns:
    
    A list of authorization options in this request
  - hasAuthorization
```
public boolean hasAuthorization()
```
    Returns:
    
    True if there was an Authorization header and the Authorization object was successfully created.
  - getFormQuery
```
public String getFormQuery(String name)
```
    Returns a query from a form which uses the 'application/x-www-form-urlencoded' request header.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    The value, null if there is none.
  - getParam
```
public String getParam(String param)
```
    Returns an param from a dynamic url.
    
    Parameters:
    
    param - The param.
    
    Returns:
    
    The value, null if there is none.
  - getQuery
```
public String getQuery(String name)
```
    Returns the value from the url-query.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    The value, null if there is none.
  - getFormQuerys
```
public HashMap<String,String> getFormQuerys()
```
    Returns all query's from an x-www-form-urlencoded body.
    
    Returns:
    
    An entire list of key-values
  - getParams
```
public HashMap<String,String> getParams()
```
    Returns all params from the url.
    
    Returns:
    
    An entire list of key-values
  - setParams
```
public void setParams(HashMap<String,String> params)
```
    Set the params.
    
    Parameters:
    
    params - Request parameter
  - getContext
```
public String getContext()
```
    Returns the corresponding context.
    
    Returns:
    
    The corresponding context.
  - setContext
```
public void setContext(String context)
```
    Set the corresponding context.
    
    Parameters:
    
    context - The corresponding context.
  - getQuerys
```
public HashMap<String,String> getQuerys()
```
    Return all url-query's.
    
    Returns:
    
    An entire list of key-values
  - getHeader
```
public List<String> getHeader(String header)
```
    Returns an header value.
    
    Parameters:
    
    header - The header name
    
    Returns:
    
    A list with values.
  - getApp
```
public Express getApp()
```
    Returns:
    
    The corresponding express object.

Class Request

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Request

Method Detail

getBody

pipe

pipe

getCookie

getCookies

addMiddlewareContent

getMiddlewareContent

getUserAgent

getHost

getAddress

getIp

getContentType

getContentLength

getPath

getURI

getMethod

isFresh

isStale

isSecure

isXHR

getProtocol

getAuthorization

hasAuthorization

getFormQuery

getParam

getQuery

getFormQuerys

getParams

setParams

getContext

setContext

getQuerys

getHeader

getApp