Request (Spark 1.0 API)

java.lang.Object
- spark.Request

```
public class Request
extends Object
```
Provides information about the HTTP request

Author:

Per Wendel

Constructor Summary

Constructors
Modifier Constructor and Description

protected Request()

Constructors
Modifier	Constructor and Description
`protected`	`Request()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`attribute(String attribute)` Gets the value of the provided attribute
`void`	`attribute(String attribute, Object value)` Sets an attribute on the request (can be fetched in filters/routes later in the chain)
`Set<String>`	`attributes()` Returns all attributes
`String`	`body()` Returns the request body sent by the client
`int`	`contentLength()` Returns the length of request.body
`String`	`contentType()` Returns the content type of the body
`String`	`cookie(String name)` Gets cookie by name.
`Map<String,String>`	`cookies()`
`Set<String>`	`headers()` Returns all headers
`String`	`headers(String header)` Returns the value of the provided header
`String`	`host()` Returns the host
`String`	`ip()` Returns the client's IP address
`String`	`params(String param)` Returns the value of the provided route pattern parameter.
`String`	`pathInfo()` Returns the path info Example return: "/example/foo"
`int`	`port()` Returns the server port
`QueryParamsMap`	`queryMap()`
`QueryParamsMap`	`queryMap(String key)`
`Set<String>`	`queryParams()` Returns all query parameters
`String`	`queryParams(String queryParam)` Returns the value of the provided queryParam Example: query parameter 'id' from the following request URI: /hello?id=foo
`String`	`queryString()` Returns the query string
`javax.servlet.http.HttpServletRequest`	`raw()` Gets the raw HttpServletRequest object handed in by Jetty
`String`	`requestMethod()` Returns request method e.g.
`String`	`scheme()` Returns the scheme
`Session`	`session()` Returns the current session associated with this request, or if the request does not have a session, creates one.
`Session`	`session(boolean create)` Returns the current session associated with this request, or if there is no current session and `create` is true, returns a new session.
`String[]`	`splat()` Returns an arrat containing the splat (wildcard) parameters
`String`	`url()` Returns the URL string
`String`	`userAgent()` Returns the user-agent

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

- Constructor Detail
  - Request
```
protected Request()
```
- Method Detail
  - params
```
public String params(String param)
```
    Returns the value of the provided route pattern parameter. Example: parameter 'name' from the following pattern: (get '/hello/:name')
    
    Returns:
    null if the given param is null or not found
  - splat
```
public String[] splat()
```
    Returns an arrat containing the splat (wildcard) parameters
  - requestMethod
```
public String requestMethod()
```
    Returns request method e.g. GET, POST, PUT, ...
  - scheme
```
public String scheme()
```
    Returns the scheme
  - host
```
public String host()
```
    Returns the host
  - userAgent
```
public String userAgent()
```
    Returns the user-agent
  - port
```
public int port()
```
    Returns the server port
  - pathInfo
```
public String pathInfo()
```
    Returns the path info Example return: "/example/foo"
  - url
```
public String url()
```
    Returns the URL string
  - contentType
```
public String contentType()
```
    Returns the content type of the body
  - ip
```
public String ip()
```
    Returns the client's IP address
  - body
```
public String body()
```
    Returns the request body sent by the client
  - contentLength
```
public int contentLength()
```
    Returns the length of request.body
  - queryParams
```
public String queryParams(String queryParam)
```
    Returns the value of the provided queryParam Example: query parameter 'id' from the following request URI: /hello?id=foo
  - headers
```
public String headers(String header)
```
    Returns the value of the provided header
  - queryParams
```
public Set<String> queryParams()
```
    Returns all query parameters
  - headers
```
public Set<String> headers()
```
    Returns all headers
  - queryString
```
public String queryString()
```
    Returns the query string
  - attribute
```
public void attribute(String attribute,
             Object value)
```
    Sets an attribute on the request (can be fetched in filters/routes later in the chain)
    
    Parameters:
    attribute - The attribute
    value - The attribute value
  - attribute
```
public Object attribute(String attribute)
```
    Gets the value of the provided attribute
    
    Parameters:
    attribute - The attribute value or null if not present
  - attributes
```
public Set<String> attributes()
```
    Returns all attributes
  - raw
```
public javax.servlet.http.HttpServletRequest raw()
```
    Gets the raw HttpServletRequest object handed in by Jetty
  - queryMap
```
public QueryParamsMap queryMap()
```
  - queryMap
```
public QueryParamsMap queryMap(String key)
```
  - session
```
public Session session()
```
    Returns the current session associated with this request, or if the request does not have a session, creates one.
    
    Returns:
    the session associated with this request
  - session
```
public Session session(boolean create)
```
    Returns the current session associated with this request, or if there is no current session and create is true, returns a new session.
    
    Parameters:
    create - true to create a new session for this request if necessary; false to return null if there's no current session
    
    Returns:
    the session associated with this request or null if create is false and the request has no valid session
  - cookies
```
public Map<String,String> cookies()
```
    Returns:
    request cookies (or empty Map if cookies dosn't present)
  - cookie
```
public String cookie(String name)
```
    Gets cookie by name.
    
    Parameters:
    name - name of the cookie
    
    Returns:
    cookie value or null if the cookie was not found

Class Request

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Request

Method Detail

params

splat

requestMethod

scheme

host

userAgent

port

pathInfo

url

contentType

ip

body

contentLength

queryParams

headers

queryParams

headers

queryString

attribute

attribute

attributes

raw

queryMap

queryMap

session

session

cookies

cookie