Request (api 1.0.0 API)

All Known Implementing Classes:

RequestImpl, RequestWrapper
```
public interface Request
```
HTTP request.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Auth`	`auth()` Returns the auth.
`java.lang.String`	`baseUrl()` Returns the base URL corresponding to the the HTTP request.
`java.lang.String`	`body()` Returns the body content as a string.
`Request`	`body(byte[] body)` Sets the raw body content.
`Request`	`body(java.lang.Object body)` Sets the body content, assuming JSON content type.
`Request`	`body(java.lang.String body)` Sets the body content by passing the string value.
`Request`	`body(java.lang.String body, ContentType contentType)` Sets the raw body content and the `content-type`.
`byte[]`	`bodyBytes()` Returns the raw body content.
`<T> java.util.List<T>`	`bodyList(java.lang.Class<T> componentType)` Returns parsed `body content` as a List.
`<K,V> java.util.Map<K,V>`	`bodyMap(java.lang.Class<K> keyType, java.lang.Class<V> valueType)` Returns parsed `body content`.
`default <V> java.util.Map<java.lang.String,V>`	`bodyMap(java.lang.Class<V> valueType)` REturns parsed `body content`.
`<T> T`	`bodyValue()` Parses the body depending on content-type.
`<T> T`	`bodyValue(java.lang.Class<T> type)` Parses the body depending on content-type into the target type.
`java.lang.String`	`contentType()` Gets the content type header.
`Request`	`contentType(ContentType contentType)` Sets the content type header.
`Context`	`context()` Returns the context that this request belongs to.
`Request`	`cookie(Cookie cookie)` Adds a cookie to the response.
`Cookie`	`cookie(java.lang.String name)` Gets cookie value by name.
`java.util.Map<java.lang.String,Cookie>`	`cookies()`
`FileUpload[]`	`fileUploads()` Returns array of uploaded files.
`java.lang.Object`	`form(java.lang.String name)` Returns the form parameter.
`Request`	`form(java.lang.String name, java.lang.Object value)` Sets the form parameter.
`MultiMap<java.lang.Object>`	`forms()` Returns form parameters.
`java.lang.String`	`header(java.lang.String name)` Gets header value by name.
`Request`	`header(java.lang.String name, java.lang.String value)` Sets the first header name with the specified value.
`MultiMap<java.lang.String>`	`headers()` Returns headers.
`boolean`	`isContentType(ContentType contentType)` Checks if the request contains a content type header with the specified value.
`java.lang.String`	`method()` Returns HTTP method, in uppercase.
`Request`	`method(java.lang.String method)` Sets method.
`void`	`next()` Delegates this request to the next handler.
`void`	`next(OnResponseEndCallback onResponseEnd)` Delegates this request to the next handler and executes the runnable on the response end.
`java.lang.String`	`param(java.lang.String name)` Gets parameter value by name.
`Request`	`param(java.lang.String name, java.lang.String value)` Sets parameter value.
`MultiMap<java.lang.String>`	`params()` Returns map of string request parameters.
`java.lang.String`	`path()` Returns action path of the URI.
`java.lang.String`	`query()` Returns the query string of the URL.
`Response`	`response()` Returns associated response of this request.
`void`	`response(Response response)` Associates response to this request.
`Session`	`session()` Returns current session.
`java.lang.String`	`url()` Returns the absolute URL corresponding to the the HTTP request.
`MultiMap<java.lang.Object>`	`values()` Merges all the inputs in best possible way.
`<T> T`	`values(java.lang.Class<T> type)` Returns merged values to a certain type.

- Method Detail
  - auth
```
Auth auth()
```
    Returns the auth.
  - baseUrl
```
java.lang.String baseUrl()
```
    Returns the base URL corresponding to the the HTTP request. If null the request represents a 'local' call, with only a path() existing.
  - body
```
java.lang.String body()
```
    Returns the body content as a string.
  - body
```
Request body(byte[] body)
```
    Sets the raw body content.
  - body
```
Request body(java.lang.Object body)
```
    Sets the body content, assuming JSON content type.
  - body
```
Request body(java.lang.String body)
```
    Sets the body content by passing the string value.
  - body
```
Request body(java.lang.String body,
             ContentType contentType)
```
    Sets the raw body content and the content-type. This is just a shortcut method.
  - bodyBytes
```
byte[] bodyBytes()
```
    Returns the raw body content.
  - bodyList
```
<T> java.util.List<T> bodyList(java.lang.Class<T> componentType)
```
    Returns parsed body content as a List.
  - bodyMap
```
<K,V> java.util.Map<K,V> bodyMap(java.lang.Class<K> keyType,
                                 java.lang.Class<V> valueType)
```
    Returns parsed body content. If body is not set, returns null.
  - bodyMap
```
default <V> java.util.Map<java.lang.String,V> bodyMap(java.lang.Class<V> valueType)
```
    REturns parsed body content. If body is not set, returns null.
  - bodyValue
```
<T> T bodyValue()
```
    Parses the body depending on content-type. If content-type is NOT set, it will use assume the "plain/text" content type. Returns parsed body content. If body is not set, returns null. If body can not be parsed, throws an Exception.
  - bodyValue
```
<T> T bodyValue(java.lang.Class<T> type)
```
    Parses the body depending on content-type into the target type.
    
    See Also:
    
    bodyValue()
  - contentType
```
java.lang.String contentType()
```
    Gets the content type header.
  - contentType
```
Request contentType(ContentType contentType)
```
    Sets the content type header.
  - context
```
Context context()
```
    Returns the context that this request belongs to.
  - cookies
```
java.util.Map<java.lang.String,Cookie> cookies()
```
    Returns:
    
    A map of all the cookies.
  - cookie
```
Request cookie(Cookie cookie)
```
    Adds a cookie to the response.
  - cookie
```
Cookie cookie(java.lang.String name)
```
    Gets cookie value by name.
  - fileUploads
```
FileUpload[] fileUploads()
```
    Returns array of uploaded files. Returns null if nothing was uploaded.
  - form
```
java.lang.Object form(java.lang.String name)
```
    Returns the form parameter.
  - form
```
Request form(java.lang.String name,
             java.lang.Object value)
```
    Sets the form parameter.
  - forms
```
MultiMap<java.lang.Object> forms()
```
    Returns form parameters.
  - header
```
java.lang.String header(java.lang.String name)
```
    Gets header value by name.
  - header
```
Request header(java.lang.String name,
               java.lang.String value)
```
    Sets the first header name with the specified value.
  - headers
```
MultiMap<java.lang.String> headers()
```
    Returns headers.
  - isContentType
```
boolean isContentType(ContentType contentType)
```
    Checks if the request contains a content type header with the specified value.
  - method
```
java.lang.String method()
```
    Returns HTTP method, in uppercase.
  - method
```
Request method(java.lang.String method)
```
    Sets method.
  - next
```
void next()
```
    Delegates this request to the next handler.
  - next
```
void next(OnResponseEndCallback onResponseEnd)
```
    Delegates this request to the next handler and executes the runnable on the response end.
  - param
```
java.lang.String param(java.lang.String name)
```
    Gets parameter value by name.
  - param
```
Request param(java.lang.String name,
              java.lang.String value)
```
    Sets parameter value.
  - params
```
MultiMap<java.lang.String> params()
```
    Returns map of string request parameters. They consist of:
    1. query parameters
    2. form parameters
    3. parameters from api.json (serialized to string)
    4. path parameters
    Parameters are accumulated in given order.
  - path
```
java.lang.String path()
```
    Returns action path of the URI. Returned path does not contain the query part. Returns "/" for the root.
  - query
```
java.lang.String query()
```
    Returns the query string of the URL.
  - response
```
Response response()
```
    Returns associated response of this request.
  - response
```
void response(Response response)
```
    Associates response to this request.
  - session
```
Session session()
```
    Returns current session.
  - url
```
java.lang.String url()
```
    Returns the absolute URL corresponding to the the HTTP request.
  - values
```
MultiMap<java.lang.Object> values()
```
    Merges all the inputs in best possible way. The following is merged in given order:
    1. parameters - parsed to a JSON, if possible
    2. bodyValue() parsed body}
    Values with the same names and different sources are accumulated in multi map. Always returns an object, never a null. When content type is one of the form content types, body is ignored.
  - values
```
<T> T values(java.lang.Class<T> type)
```
    Returns merged values to a certain type.
    
    See Also:
    
    values()

Interface Request

Method Summary

Method Detail

auth

baseUrl

body

body

body

body

body

bodyBytes

bodyList

bodyMap

bodyMap

bodyValue

bodyValue

contentType

contentType

context

cookies

cookie

cookie

fileUploads

form

form

forms

header

header

headers

isContentType

method

method

next

next

param

param

params

path

query

response

response

session

url

values

values