Response (api 1.0.0 API)

All Known Implementing Classes:

ResponseImpl, ResponseWrapper
```
public interface Response
```
HTTP response.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Response.Status
Simple static collection of all statuses as constants.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Response.Status` Simple static collection of all statuses as constants.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.lang.String`	`body()` Returns body content.
`Response`	`body(byte[] body)` Sets the raw body content.
`Response`	`body(java.lang.Object body)` Sets the JSON body content.
`Response`	`body(java.lang.String body)` Sets the body content.
`Response`	`body(java.lang.String body, ContentType contentType)` Sets the body content and common `content-type`.
`byte[]`	`bodyBytes()` Returns the raw body content.
`<T> java.util.List<T>`	`bodyList(java.lang.Class<T> componentType)` Returns parsed `body content`.
`<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()` Returns parsed `body content`.
`<T> T`	`bodyValue(java.lang.Class<T> type)` Returns parsed `body content`.
`java.lang.String`	`contentType()` Gets the content type header.
`Response`	`contentType(ContentType contentType)` Sets the content type header.
`Context`	`context()` Returns the context that this response belongs to.
`Response`	`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()`
`void`	`end()` Closes the response.
`default void`	`end(java.lang.Object body)` Sets the body and clsoes the response.
`default void`	`end(java.lang.String body)` Sets the body content and closes the response.
`default void`	`end(java.lang.String body, ContentType contentType)` Sets the body content and common `content-type` and closes the response.
`java.lang.String`	`header(java.lang.String name)` Gets header value by name.
`Response`	`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`	`isCommitted()` Returns `true` if response is already committed.
`boolean`	`isContentType(ContentType contentType)` Checks if the response contains a content type header with the specified value.
`Response`	`pipe(Response response)` Pipes response to another response and ends it.
`default void`	`redirect(java.lang.String url)` Redirects response to an url.
`Request`	`request()` Returns associated request of this response.
`default Session`	`session()` Returns current session.
`default Response`	`status(int statusCode)` Sets the response status code and default status message.
`Response`	`status(int statusCode, java.lang.String statusMessage)` Sets the response status code and message.
`int`	`statusCode()` Returns status code.
`java.lang.String`	`statusMessage()` Returns status message.
`default boolean`	`succeeded()` Checks if response succeeded.

- Method Detail
  - body
```
java.lang.String body()
```
    Returns body content.
  - body
```
Response body(byte[] body)
```
    Sets the raw body content.
  - body
```
Response body(java.lang.Object body)
```
    Sets the JSON body content.
  - body
```
Response body(java.lang.String body)
```
    Sets the body content. Body content can be set more then once.
  - body
```
Response body(java.lang.String body,
              ContentType contentType)
```
    Sets the body content and common content-type. Just a shortcut call.
  - bodyBytes
```
byte[] bodyBytes()
```
    Returns the raw body content.
  - bodyList
```
<T> java.util.List<T> bodyList(java.lang.Class<T> componentType)
```
    Returns parsed body content. If body is not set, returns null.
  - 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()
```
    Returns parsed body content. If body is not set, returns null.
  - bodyValue
```
<T> T bodyValue(java.lang.Class<T> type)
```
    Returns parsed body content. If body is not set, returns null.
  - contentType
```
java.lang.String contentType()
```
    Gets the content type header.
  - contentType
```
Response contentType(ContentType contentType)
```
    Sets the content type header.
  - context
```
Context context()
```
    Returns the context that this response belongs to.
  - cookies
```
java.util.Map<java.lang.String,Cookie> cookies()
```
    Returns:
    
    A map of all the cookies.
  - cookie
```
Response cookie(Cookie cookie)
```
    Adds a cookie to the response.
  - cookie
```
Cookie cookie(java.lang.String name)
```
    Gets cookie value by name.
  - end
```
void end()
```
    Closes the response. Shortcut for body(null).
  - end
```
default void end(java.lang.Object body)
```
    Sets the body and clsoes the response.
  - end
```
default void end(java.lang.String body)
```
    Sets the body content and closes the response.
  - end
```
default void end(java.lang.String body,
                 ContentType contentType)
```
    Sets the body content and common content-type and closes the response.
  - header
```
java.lang.String header(java.lang.String name)
```
    Gets header value by name.
  - header
```
Response 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.
  - isCommitted
```
boolean isCommitted()
```
    Returns true if response is already committed.
  - isContentType
```
boolean isContentType(ContentType contentType)
```
    Checks if the response contains a content type header with the specified value.
  - pipe
```
Response pipe(Response response)
```
    Pipes response to another response and ends it.
  - redirect
```
default void redirect(java.lang.String url)
```
    Redirects response to an url.
  - request
```
Request request()
```
    Returns associated request of this response.
  - session
```
default Session session()
```
    Returns current session.
  - status
```
default Response status(int statusCode)
```
    Sets the response status code and default status message.
  - status
```
Response status(int statusCode,
                java.lang.String statusMessage)
```
    Sets the response status code and message.
  - statusCode
```
int statusCode()
```
    Returns status code.
  - statusMessage
```
java.lang.String statusMessage()
```
    Returns status message.
  - succeeded
```
default boolean succeeded()
```
    Checks if response succeeded. Any status code 2xx or 3xx is considered valid.

Interface Response

Nested Class Summary

Method Summary

Method Detail

body

body

body

body

body

bodyBytes

bodyList

bodyMap

bodyMap

bodyValue

bodyValue

contentType

contentType

context

cookies

cookie

cookie

end

end

end

end

header

header

headers

isCommitted

isContentType

pipe

redirect

request

session

status

status

statusCode

statusMessage

succeeded