Context (jooby 2.0.0.M3 API)

```
public interface Context
```
HTTP context allows you to interact with the HTTP Request and manipulate the HTTP Response.

Since:

2.0.0

Author:

edgar

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT` Constant for `Accept` header.
`static ZoneId`	`GMT` Constant for GMT.
`static DateTimeFormatter`	`RFC1123` RFC1123 date formatter.
`static String`	`RFC1123_PATTERN` RFC1123 date pattern.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default MediaType`	`accept(List<MediaType> produceTypes)` Check if the accept type list matches the given produces list and return the most specific media type from produces list.
`default boolean`	`accept(MediaType contentType)` True if the given type matches the `Accept` header.
`default <T> T`	`attribute(String key)` Get an attribute by his key.
`default Context`	`attribute(String key, Object value)` Set an application attribute.
`Body`	`body()` HTTP body which provides access to body content.
`default <T> T`	`body(Class type)` Convert the HTTP body to the given type.
`default <T> T`	`body(Class type, MediaType contentType)` Convert the HTTP body to the given type.
`default <T> T`	`body(Reified<T> type)` Convert the HTTP body to the given type.
`default <T> T`	`body(Reified<T> type, MediaType contentType)` Convert the HTTP body to the given type.
`Context`	`detach(Runnable action)` Tells context that response will be generated form a different thread.
`Context`	`dispatch(Executor executor, Runnable action)` Dispatch context to the given executor.
`Context`	`dispatch(Runnable action)` Dispatch context to a worker threads.
`default FileUpload`	`file(String name)` A file upload that matches the given field name.
`default List<FileUpload>`	`files()` All file uploads.
`default List<FileUpload>`	`files(String name)` All file uploads that matches the given field name.
`Formdata`	`form()` Formdata as `Value`.
`default <T> T`	`form(Class<T> type)` Convert formdata to the given type.
`default <T> T`	`form(Reified<T> type)` Convert formdata to the given type.
`default Value`	`form(String name)` Form field that matches the given name.
`default Map<String,String>`	`formMap()` Formdata as single-value map.
`default Map<String,List<String>>`	`formMultimap()` Formdata as multi-value map.
`Map<String,Object>`	`getAttributes()` Context attributes (a.k.a request attributes).
`default String`	`getHost()` The fully qualified name of the resource being requested, as obtained from the Host HTTP header.
`String`	`getMethod()` HTTP method in upper-case form.
`String`	`getProtocol()` The name of the protocol the request.
`String`	`getRemoteAddress()` The IP address of the client or last proxy that sent the request.
`default long`	`getRequestLength()` Request `Content-Length` header or `-1` when missing.
`default MediaType`	`getRequestType()` Request `Content-Type` header or `null` when missing.
`default MediaType`	`getRequestType(MediaType defaults)` Request `Content-Type` header or `null` when missing.
`MediaType`	`getResponseType()` Get response content type.
`Route`	`getRoute()` Matching route.
`Router`	`getRouter()` Get the HTTP router (usually this represent an instance of `Jooby`.
`String`	`getScheme()` HTTP scheme in lower case.
`StatusCode`	`getStatusCode()` Get response status code.
`default Value`	`header(String name)` Get a header that matches the given name.
`default Map<String,String>`	`headerMap()` Header as single-value map.
`default Map<String,List<String>>`	`headerMultimap()` Header as multi-value map.
`Value`	`headers()` Request headers as `Value`.
`boolean`	`isInIoThread()` True when request runs in IO threads.
`boolean`	`isResponseStarted()` True if response already started.
`Multipart`	`multipart()` Get multipart data.
`default <T> T`	`multipart(Class<T> type)` Convert multipart data to the given type.
`default <T> T`	`multipart(Reified<T> type)` Convert multipart data to the given type.
`default Value`	`multipart(String name)` Get a multipart field that matches the given name.
`default Map<String,String>`	`multipartMap()` Multipart data as single-value map.
`default Map<String,List<String>>`	`multipartMultimap()` Multipart data as multi-value map.
`default Parser`	`parser(MediaType contentType)` Get a parser for the given content type or get an `StatusCode.UNSUPPORTED_MEDIA_TYPE`.
`default Value`	`path()` Convert `pathMap()` to a `Value` object.
`default <T> T`	`path(Class<T> type)` Convert the `pathMap()` to the given type.
`default <T> T`	`path(Reified<T> type)` Convert the `pathMap()` to the given type.
`default Value`	`path(String name)` Path variable.
`Map<String,String>`	`pathMap()` Path map represent all the path keys with their values.
`String`	`pathString()` Request path without decoding (a.k.a raw Path) without query string.
`QueryString`	`query()` Query string as `Value` object.
`default <T> T`	`query(Class<T> type)` Convert the queryString to the given type.
`default <T> T`	`query(Reified<T> type)` Convert the queryString to the given type.
`default Value`	`query(String name)` Get a query parameter that matches the given name.
`default Map<String,String>`	`queryMap()` Query string as simple map.
`default Map<String,List<String>>`	`queryMultimap()` Query string as multi-value map.
`default String`	`queryString()` Query string with the leading `?` or empty string.
`default Context`	`render(Object value)` Render a value and send the response to client.
`Sender`	`responseSender()` HTTP response channel as chunker.
`OutputStream`	`responseStream()` HTTP response channel as output stream.
`default OutputStream`	`responseStream(MediaType contentType)` HTTP response channel as output stream.
`default Context`	`responseStream(MediaType contentType, Throwing.Consumer<OutputStream> consumer)` HTTP response channel as output stream.
`default Context`	`responseStream(Throwing.Consumer<OutputStream> consumer)` HTTP response channel as output stream.
`default PrintWriter`	`responseWriter()` HTTP response channel as response writer.
`default PrintWriter`	`responseWriter(MediaType contentType)` HTTP response channel as response writer.
`PrintWriter`	`responseWriter(MediaType contentType, Charset charset)` HTTP response channel as response writer.
`default Context`	`responseWriter(MediaType contentType, Charset charset, Throwing.Consumer<PrintWriter> consumer)` HTTP response channel as response writer.
`default Context`	`responseWriter(MediaType contentType, Throwing.Consumer<PrintWriter> consumer)` HTTP response channel as response writer.
`default Context`	`responseWriter(Throwing.Consumer<PrintWriter> consumer)` HTTP response channel as response writer.
`default Context`	`send(AttachedFile file)` Send a file attached response.
`Context`	`send(byte[] data)` Send response data.
`default Context`	`send(io.netty.buffer.ByteBuf data)` Send response data.
`Context`	`send(ByteBuffer data)` Send response data.
`Context`	`send(FileChannel file)` Send a file response.
`Context`	`send(InputStream input)` Send response data.
`default Context`	`send(Path file)` Send a file response.
`Context`	`send(ReadableByteChannel channel)` Send response data.
`Context`	`send(StatusCode statusCode)` Send an empty response with the given status code.
`default Context`	`send(String data)` Send response data.
`Context`	`send(String data, Charset charset)` Send response data.
`default Context`	`sendError(Throwable cause)` Send an error response.
`default Context`	`sendError(Throwable cause, StatusCode statusCode)` Send an error response.
`default Context`	`sendRedirect(StatusCode redirect, String location)` Send a redirect response.
`default Context`	`sendRedirect(String location)` Send a `302` response.
`Context`	`setDefaultResponseType(MediaType contentType)` Set the default response content type header.
`default Context`	`setHeader(String name, Date value)` Set response header.
`default Context`	`setHeader(String name, Instant value)` Set response header.
`default Context`	`setHeader(String name, Object value)` Set response header.
`Context`	`setHeader(String name, String value)` Set response header.
`Context`	`setPathMap(Map<String,String> pathMap)` Set path map.
`Context`	`setResponseLength(long length)` Set response content length header.
`default Context`	`setResponseType(MediaType contentType)` Set response content type header.
`Context`	`setResponseType(MediaType contentType, Charset charset)` Set response content type header.
`Context`	`setResponseType(String contentType)` Set response content type header.
`Context`	`setRoute(Route route)` Set matching route.
`Context`	`setStatusCode(int statusCode)` Set response status code.
`default Context`	`setStatusCode(StatusCode statusCode)` Set response status code.

- Field Detail
  - ACCEPT
```
static final String ACCEPT
```
    Constant for Accept header.
    
    See Also:
    
    Constant Field Values
  - GMT
```
static final ZoneId GMT
```
    Constant for GMT.
  - RFC1123_PATTERN
```
static final String RFC1123_PATTERN
```
    RFC1123 date pattern.
    
    See Also:
    
    Constant Field Values
  - RFC1123
```
static final DateTimeFormatter RFC1123
```
    RFC1123 date formatter.
- Method Detail
  - getAttributes
```
@Nonnull
Map<String,Object> getAttributes()
```
    Context attributes (a.k.a request attributes).
    
    Returns:
    
    Context attributes.
  - attribute
```
@Nonnull
default <T> T attribute(@Nonnull
                                 String key)
```
    Get an attribute by his key. This is just an utility method around getAttributes(). This method look first in current context and fallback to application attributes.
    
    Type Parameters:
    
    T - Attribute type.
    
    Parameters:
    
    key - Attribute key.
    
    Returns:
    
    Attribute value.
  - attribute
```
@Nonnull
default Context attribute(@Nonnull
                                   String key,
                                   Object value)
```
    Set an application attribute.
    
    Parameters:
    
    key - Attribute key.
    
    value - Attribute value.
    
    Returns:
    
    This router.
  - getRouter
```
@Nonnull
Router getRouter()
```
    Get the HTTP router (usually this represent an instance of Jooby.
    
    Returns:
    
    HTTP router (usually this represent an instance of Jooby.
  - getMethod
```
@Nonnull
String getMethod()
```
    HTTP method in upper-case form.
    
    Returns:
    
    HTTP method in upper-case form.
  - getRoute
```
@Nonnull
Route getRoute()
```
    Matching route.
    
    Returns:
    
    Matching route.
  - setRoute
```
@Nonnull
Context setRoute(@Nonnull
                          Route route)
```
    Set matching route. This is part of public API, but shouldn't be use by application code.
    
    Parameters:
    
    route - Matching route.
    
    Returns:
    
    This context.
  - pathString
```
@Nonnull
String pathString()
```
    Request path without decoding (a.k.a raw Path) without query string.
    
    Returns:
    
    Request path without decoding (a.k.a raw Path) without query string.
  - path
```
@Nonnull
default Value path(@Nonnull
                            String name)
```
    Path variable. Value is decoded.
    
    Parameters:
    
    name - Path key.
    
    Returns:
    
    Associated value or a missing value, but never a null reference.
  - path
```
@Nonnull
default <T> T path(@Nonnull
                            Reified<T> type)
```
    Convert the pathMap() to the given type.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Instance of target type.
  - path
```
@Nonnull
default <T> T path(@Nonnull
                            Class<T> type)
```
    Convert the pathMap() to the given type.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Target type.
    
    Returns:
    
    Instance of target type.
  - path
```
@Nonnull
default Value path()
```
    Convert pathMap() to a Value object.
    
    Returns:
    
    A value object.
  - pathMap
```
@Nonnull
Map<String,String> pathMap()
```
    Path map represent all the path keys with their values.
```
 {
   get("/:id", ctx -> ctx.pathMap());
 }
 
```
    A call to:
```
GET /678
```
    Produces a path map like: id: 678
    Returns:
    
    Path map from path pattern.
  - setPathMap
```
@Nonnull
Context setPathMap(@Nonnull
                            Map<String,String> pathMap)
```
    Set path map. This method is part of public API but shouldn't be use it by application code.
    
    Parameters:
    
    pathMap - Path map.
    
    Returns:
    
    This context.
  - query
```
@Nonnull
QueryString query()
```
    Query string as Value object.
    
    Returns:
    
    Query string as Value object.
  - query
```
@Nonnull
default Value query(@Nonnull
                             String name)
```
    Get a query parameter that matches the given name.
```
 {
   get("/search", ctx -> {
     String q = ctx.query("q").value();
     ...
   });

 }
 
```
    Parameters:
    
    name - Parameter name.
    
    Returns:
    
    A query value.
  - queryString
```
@Nonnull
default String queryString()
```
    Query string with the leading ? or empty string. This is the raw query string, without decoding it.
    
    Returns:
    
    Query string with the leading ? or empty string. This is the raw query string, without decoding it.
  - query
```
@Nonnull
default <T> T query(@Nonnull
                             Reified<T> type)
```
    Convert the queryString to the given type.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Query string converted to target type.
  - query
```
@Nonnull
default <T> T query(@Nonnull
                             Class<T> type)
```
    Convert the queryString to the given type.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Target type.
    
    Returns:
    
    Query string converted to target type.
  - queryMap
```
@Nonnull
default Map<String,String> queryMap()
```
    Query string as simple map.
    Produces
```
{q: jooby, sort: name}
```
    Returns:
    
    Query string as map.
  - queryMultimap
```
@Nonnull
default Map<String,List<String>> queryMultimap()
```
    Query string as multi-value map.
    Produces
```
{q: [jooby], sort: [name, id]}
```
    Returns:
    
    Query string as map.
  - headers
```
@Nonnull
Value headers()
```
    Request headers as Value.
    
    Returns:
    
    Request headers as Value.
  - header
```
@Nonnull
default Value header(@Nonnull
                              String name)
```
    Get a header that matches the given name.
    
    Parameters:
    
    name - Header name. Case insensitive.
    
    Returns:
    
    A header value or missing value, never a null reference.
  - headerMap
```
@Nonnull
default Map<String,String> headerMap()
```
    Header as single-value map.
    
    Returns:
    
    Header as single-value map.
  - headerMultimap
```
@Nonnull
default Map<String,List<String>> headerMultimap()
```
    Header as multi-value map.
    
    Returns:
    
    Header as multi-value map.
  - accept
```
default boolean accept(@Nonnull
                       MediaType contentType)
```
    True if the given type matches the `Accept` header. This method returns true if there is no accept header.
    
    Parameters:
    
    contentType - Content type to match.
    
    Returns:
    
    True for matching type or if content header is absent.
  - accept
```
default MediaType accept(@Nonnull
                         List<MediaType> produceTypes)
```
    Check if the accept type list matches the given produces list and return the most specific media type from produces list.
    
    Parameters:
    
    produceTypes - Produced types.
    
    Returns:
    
    The most specific produces type.
  - getRequestType
```
@Nullable
default MediaType getRequestType()
```
    Request Content-Type header or null when missing.
    
    Returns:
    
    Request Content-Type header or null when missing.
  - getRequestType
```
@Nonnull
default MediaType getRequestType(MediaType defaults)
```
    Request Content-Type header or null when missing.
    
    Parameters:
    
    defaults - Default content type to use when the header is missing.
    
    Returns:
    
    Request Content-Type header or null when missing.
  - getRequestLength
```
default long getRequestLength()
```
    Request Content-Length header or -1 when missing.
    
    Returns:
    
    Request Content-Length header or -1 when missing.
  - getRemoteAddress
```
@Nonnull
String getRemoteAddress()
```
    The IP address of the client or last proxy that sent the request.
    
    Returns:
    
    The IP address of the client or last proxy that sent the request.
  - getHost
```
@Nonnull
default String getHost()
```
    The fully qualified name of the resource being requested, as obtained from the Host HTTP header.
    
    Returns:
    
    The fully qualified name of the server.
  - getProtocol
```
@Nonnull
String getProtocol()
```
    The name of the protocol the request. Always in lower-case.
    
    Returns:
    
    The name of the protocol the request. Always in lower-case.
  - getScheme
```
@Nonnull
String getScheme()
```
    HTTP scheme in lower case.
    
    Returns:
    
    HTTP scheme in lower case.
  - form
```
@Nonnull
Formdata form()
```
    Formdata as Value. This method is for application/form-url-encoded request.
    
    Returns:
    
    Formdata as Value. This method is for application/form-url-encoded request.
  - formMultimap
```
@Nonnull
default Map<String,List<String>> formMultimap()
```
    Formdata as multi-value map. Only for application/form-url-encoded request.
    
    Returns:
    
    Formdata as multi-value map. Only for application/form-url-encoded request.
  - formMap
```
@Nonnull
default Map<String,String> formMap()
```
    Formdata as single-value map. Only for application/form-url-encoded request.
    
    Returns:
    
    Formdata as single-value map. Only for application/form-url-encoded request.
  - form
```
@Nonnull
default Value form(@Nonnull
                            String name)
```
    Form field that matches the given name. Only for application/form-url-encoded request.
    
    Parameters:
    
    name - Field name.
    
    Returns:
    
    Form value.
  - form
```
@Nonnull
default <T> T form(@Nonnull
                            Reified<T> type)
```
    Convert formdata to the given type. Only for application/form-url-encoded request.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Formdata as requested type.
  - form
```
@Nonnull
default <T> T form(@Nonnull
                            Class<T> type)
```
    Convert formdata to the given type. Only for application/form-url-encoded request.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Target type.
    
    Returns:
    
    Formdata as requested type.
  - multipart
```
@Nonnull
Multipart multipart()
```
    Get multipart data. Only for multipart/form-data request..
    
    Returns:
    
    Multipart value.
  - multipart
```
@Nonnull
default Value multipart(@Nonnull
                                 String name)
```
    Get a multipart field that matches the given name. File upload retrieval is available using Value.fileUpload() or consider using the file(String) instead. Only for multipart/form-data request.
    
    Parameters:
    
    name - Field name.
    
    Returns:
    
    Multipart value.
  - multipart
```
@Nonnull
default <T> T multipart(@Nonnull
                                 Reified<T> type)
```
    Convert multipart data to the given type. Only for multipart/form-data request.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Target value.
  - multipart
```
@Nonnull
default <T> T multipart(@Nonnull
                                 Class<T> type)
```
    Convert multipart data to the given type. Only for multipart/form-data request.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    type - Target type.
    
    Returns:
    
    Target value.
  - multipartMultimap
```
@Nonnull
default Map<String,List<String>> multipartMultimap()
```
    Multipart data as multi-value map. Only for multipart/form-data request.
    
    Returns:
    
    Multi-value map.
  - multipartMap
```
@Nonnull
default Map<String,String> multipartMap()
```
    Multipart data as single-value map. Only for multipart/form-data request.
    
    Returns:
    
    Single-value map.
  - files
```
@Nonnull
default List<FileUpload> files()
```
    All file uploads. Only for multipart/form-data request.
    
    Returns:
    
    All file uploads.
  - files
```
@Nonnull
default List<FileUpload> files(@Nonnull
                                        String name)
```
    All file uploads that matches the given field name. Only for multipart/form-data request.
    
    Parameters:
    
    name - Field name. Please note this is the form field name, not the actual file name.
    
    Returns:
    
    All file uploads.
  - file
```
@Nonnull
default FileUpload file(@Nonnull
                                 String name)
```
    A file upload that matches the given field name. Only for multipart/form-data request.
    
    Parameters:
    
    name - Field name. Please note this is the form field name, not the actual file name.
    
    Returns:
    
    A file upload.
  - body
```
@Nonnull
Body body()
```
    HTTP body which provides access to body content.
    
    Returns:
    
    HTTP body which provides access to body content.
  - body
```
@Nonnull
default <T> T body(@Nonnull
                            Reified<T> type)
```
    Convert the HTTP body to the given type.
    
    Type Parameters:
    
    T - Conversion type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Instance of conversion type.
  - body
```
@Nonnull
default <T> T body(@Nonnull
                            Reified<T> type,
                            @Nonnull
                            MediaType contentType)
```
    Convert the HTTP body to the given type.
    
    Type Parameters:
    
    T - Conversion type.
    
    Parameters:
    
    type - Reified type.
    
    contentType - Body content type.
    
    Returns:
    
    Instance of conversion type.
  - body
```
@Nonnull
default <T> T body(@Nonnull
                            Class type)
```
    Convert the HTTP body to the given type.
    
    Type Parameters:
    
    T - Conversion type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Instance of conversion type.
  - body
```
@Nonnull
default <T> T body(@Nonnull
                            Class type,
                            @Nonnull
                            MediaType contentType)
```
    Convert the HTTP body to the given type.
    
    Type Parameters:
    
    T - Conversion type.
    
    Parameters:
    
    type - Reified type.
    
    contentType - Body content type.
    
    Returns:
    
    Instance of conversion type.
  - parser
```
@Nonnull
default Parser parser(@Nonnull
                               MediaType contentType)
```
    Get a parser for the given content type or get an StatusCode.UNSUPPORTED_MEDIA_TYPE.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    Parser.
  - isInIoThread
```
boolean isInIoThread()
```
    True when request runs in IO threads.
    
    Returns:
    
    True when request runs in IO threads.
  - dispatch
```
@Nonnull
Context dispatch(@Nonnull
                          Runnable action)
```
    Dispatch context to a worker threads. Worker threads allow to execute blocking code. The default worker thread pool is provided by web server or by application code using the Jooby.setWorker(Executor). Example:
```
   get("/", ctx -> {
     return ctx.dispatch(() -> {

       // run blocking code

     }):
   });

 
```
    Parameters:
    
    action - Application code.
    
    Returns:
    
    This context.
  - dispatch
```
@Nonnull
Context dispatch(@Nonnull
                          Executor executor,
                          @Nonnull
                          Runnable action)
```
    Dispatch context to the given executor. Example:
```
   Executor executor = ...;
   get("/", ctx -> {
     return ctx.dispatch(executor, () -> {

       // run blocking code

     }):
   });

 
```
    Parameters:
    
    executor - Executor to use.
    
    action - Application code.
    
    Returns:
    
    This context.
  - detach
```
@Nonnull
Context detach(@Nonnull
                        Runnable action)
```
    Tells context that response will be generated form a different thread. This operation is similar to dispatch(Runnable) except there is no thread dispatching here. This operations integrates easily with third-party libraries liks rxJava or others.
    
    Parameters:
    
    action - Application code.
    
    Returns:
    
    This context.
  - setHeader
```
@Nonnull
default Context setHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Date value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setHeader
```
@Nonnull
default Context setHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Instant value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setHeader
```
@Nonnull
default Context setHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Object value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setHeader
```
@Nonnull
Context setHeader(@Nonnull
                           String name,
                           @Nonnull
                           String value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setResponseLength
```
@Nonnull
Context setResponseLength(long length)
```
    Set response content length header.
    
    Parameters:
    
    length - Response length.
    
    Returns:
    
    This context.
  - setResponseType
```
@Nonnull
Context setResponseType(@Nonnull
                                 String contentType)
```
    Set response content type header.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    This context.
  - setResponseType
```
@Nonnull
default Context setResponseType(@Nonnull
                                         MediaType contentType)
```
    Set response content type header.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    This context.
  - setResponseType
```
@Nonnull
Context setResponseType(@Nonnull
                                 MediaType contentType,
                                 @Nullable
                                 Charset charset)
```
    Set response content type header.
    
    Parameters:
    
    contentType - Content type.
    
    charset - Charset.
    
    Returns:
    
    This context.
  - setDefaultResponseType
```
@Nonnull
Context setDefaultResponseType(@Nonnull
                                        MediaType contentType)
```
    Set the default response content type header. It is used if the response content type header was not set yet.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    This context.
  - getResponseType
```
@Nonnull
MediaType getResponseType()
```
    Get response content type.
    
    Returns:
    
    Response content type.
  - setStatusCode
```
@Nonnull
default Context setStatusCode(@Nonnull
                                       StatusCode statusCode)
```
    Set response status code.
    
    Parameters:
    
    statusCode - Status code.
    
    Returns:
    
    This context.
  - setStatusCode
```
@Nonnull
Context setStatusCode(int statusCode)
```
    Set response status code.
    
    Parameters:
    
    statusCode - Status code.
    
    Returns:
    
    This context.
  - getStatusCode
```
@Nonnull
StatusCode getStatusCode()
```
    Get response status code.
    
    Returns:
    
    Response status code.
  - render
```
@Nonnull
default Context render(@Nonnull
                                Object value)
```
    Render a value and send the response to client.
    
    Parameters:
    
    value - Object value.
    
    Returns:
    
    This context.
  - responseStream
```
@Nonnull
OutputStream responseStream()
```
    HTTP response channel as output stream. Usually for chunked responses.
    
    Returns:
    
    HTTP channel as output stream. Usually for chunked responses.
  - responseStream
```
@Nonnull
default OutputStream responseStream(@Nonnull
                                             MediaType contentType)
```
    HTTP response channel as output stream. Usually for chunked responses.
    
    Parameters:
    
    contentType - Media type.
    
    Returns:
    
    HTTP channel as output stream. Usually for chunked responses.
  - responseStream
```
@Nonnull
default Context responseStream(@Nonnull
                                        MediaType contentType,
                                        @Nonnull
                                        Throwing.Consumer<OutputStream> consumer)
                                 throws Exception
```
    HTTP response channel as output stream. Usually for chunked responses.
    
    Parameters:
    
    contentType - Content type.
    
    consumer - Output stream consumer.
    
    Returns:
    
    HTTP channel as output stream. Usually for chunked responses.
    
    Throws:
    
    Exception - Is something goes wrong.
  - responseStream
```
@Nonnull
default Context responseStream(@Nonnull
                                        Throwing.Consumer<OutputStream> consumer)
                                 throws Exception
```
    HTTP response channel as output stream. Usually for chunked responses.
    
    Parameters:
    
    consumer - Output stream consumer.
    
    Returns:
    
    HTTP channel as output stream. Usually for chunked responses.
    
    Throws:
    
    Exception - Is something goes wrong.
  - responseSender
```
@Nonnull
Sender responseSender()
```
    HTTP response channel as chunker.
    
    Returns:
    
    HTTP channel as chunker. Usually for chunked response.
  - responseWriter
```
@Nonnull
default PrintWriter responseWriter()
```
    HTTP response channel as response writer.
    
    Returns:
    
    HTTP channel as response writer. Usually for chunked response.
  - responseWriter
```
@Nonnull
default PrintWriter responseWriter(@Nonnull
                                            MediaType contentType)
```
    HTTP response channel as response writer.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    HTTP channel as response writer. Usually for chunked response.
  - responseWriter
```
@Nonnull
PrintWriter responseWriter(@Nonnull
                                    MediaType contentType,
                                    @Nullable
                                    Charset charset)
```
    HTTP response channel as response writer.
    
    Parameters:
    
    contentType - Content type.
    
    charset - Charset.
    
    Returns:
    
    HTTP channel as response writer. Usually for chunked response.
  - responseWriter
```
@Nonnull
default Context responseWriter(@Nonnull
                                        Throwing.Consumer<PrintWriter> consumer)
                                 throws Exception
```
    HTTP response channel as response writer.
    
    Parameters:
    
    consumer - Writer consumer.
    
    Returns:
    
    This context.
    
    Throws:
    
    Exception - Is something goes wrong.
  - responseWriter
```
@Nonnull
default Context responseWriter(@Nonnull
                                        MediaType contentType,
                                        @Nonnull
                                        Throwing.Consumer<PrintWriter> consumer)
                                 throws Exception
```
    HTTP response channel as response writer.
    
    Parameters:
    
    contentType - Content type.
    
    consumer - Writer consumer.
    
    Returns:
    
    This context.
    
    Throws:
    
    Exception - Is something goes wrong.
  - responseWriter
```
@Nonnull
default Context responseWriter(@Nonnull
                                        MediaType contentType,
                                        @Nullable
                                        Charset charset,
                                        @Nonnull
                                        Throwing.Consumer<PrintWriter> consumer)
                                 throws Exception
```
    HTTP response channel as response writer.
    
    Parameters:
    
    contentType - Content type.
    
    charset - Charset.
    
    consumer - Writer consumer.
    
    Returns:
    
    This context.
    
    Throws:
    
    Exception - Is something goes wrong.
  - sendRedirect
```
@Nonnull
default Context sendRedirect(@Nonnull
                                      String location)
```
    Send a 302 response.
    
    Parameters:
    
    location - Location.
    
    Returns:
    
    This context.
  - sendRedirect
```
@Nonnull
default Context sendRedirect(@Nonnull
                                      StatusCode redirect,
                                      @Nonnull
                                      String location)
```
    Send a redirect response.
    
    Parameters:
    
    redirect - Redirect status code.
    
    location - Location.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
default Context send(@Nonnull
                              String data)
```
    Send response data.
    
    Parameters:
    
    data - Response. Use UTF-8 charset.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      String data,
                      @Nonnull
                      Charset charset)
```
    Send response data.
    
    Parameters:
    
    data - Response.
    
    charset - Charset.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      byte[] data)
```
    Send response data.
    
    Parameters:
    
    data - Response.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      ByteBuffer data)
```
    Send response data.
    
    Parameters:
    
    data - Response.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
default Context send(@Nonnull
                              io.netty.buffer.ByteBuf data)
```
    Send response data.
    
    Parameters:
    
    data - Response.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      ReadableByteChannel channel)
```
    Send response data.
    
    Parameters:
    
    channel - Response input.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      InputStream input)
```
    Send response data.
    
    Parameters:
    
    input - Response.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
default Context send(@Nonnull
                              AttachedFile file)
```
    Send a file attached response.
    
    Parameters:
    
    file - Attached file.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
default Context send(@Nonnull
                              Path file)
```
    Send a file response.
    
    Parameters:
    
    file - File response.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      FileChannel file)
```
    Send a file response.
    
    Parameters:
    
    file - File response.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
Context send(@Nonnull
                      StatusCode statusCode)
```
    Send an empty response with the given status code.
    
    Parameters:
    
    statusCode - Status code.
    
    Returns:
    
    This context.
  - sendError
```
@Nonnull
default Context sendError(@Nonnull
                                   Throwable cause)
```
    Send an error response. Status code is computed via Router.errorCode(Throwable).
    
    Parameters:
    
    cause - Error. If this is a fatal error it is going to be rethrow it.
    
    Returns:
    
    This context.
  - sendError
```
@Nonnull
default Context sendError(@Nonnull
                                   Throwable cause,
                                   @Nonnull
                                   StatusCode statusCode)
```
    Send an error response.
    
    Parameters:
    
    cause - Error. If this is a fatal error it is going to be rethrow it.
    
    statusCode - Status code.
    
    Returns:
    
    This context.
  - isResponseStarted
```
boolean isResponseStarted()
```
    True if response already started.
    
    Returns:
    
    True if response already started.

Interface Context

Field Summary

Method Summary

Field Detail

ACCEPT

GMT

RFC1123_PATTERN

RFC1123

Method Detail

getAttributes

attribute

attribute

getRouter

getMethod

getRoute

setRoute

pathString

path

path

path

path

pathMap

setPathMap

query

query

queryString

query

query

queryMap

queryMultimap

headers

header

headerMap

headerMultimap

accept

accept

getRequestType

getRequestType

getRequestLength

getRemoteAddress

getHost

getProtocol

getScheme

form

formMultimap

formMap

form

form

form

multipart

multipart

multipart

multipart

multipartMultimap

multipartMap

files

files

file

body

body

body

body

body

parser

isInIoThread

dispatch

dispatch

detach

setHeader

setHeader

setHeader

setHeader

setResponseLength

setResponseType

setResponseType

setResponseType

setDefaultResponseType

getResponseType

setStatusCode

setStatusCode