Context (jooby 2.8.2 API)

All Superinterfaces:

Registry

All Known Subinterfaces:

DefaultContext

All Known Implementing Classes:

ForwardingContext, HeadContext, ReadOnlyContext, WebSocketSender
```
public interface Context
extends Registry
```
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 int`	`PORT` Constant for default HTTP port.
`static DateTimeFormatter`	`RFC1123` RFC1123 date formatter.
`static String`	`RFC1123_PATTERN` RFC1123 date pattern.
`static int`	`SECURE_PORT` Constant for default HTTPS port.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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.
`boolean`	`accept(MediaType contentType)` True if the given type matches the `Accept` header.
`<T> T`	`attribute(String key)` Get an attribute by his key.
`Context`	`attribute(String key, Object value)` Set an application attribute.
`Body`	`body()` HTTP body which provides access to body content.
`<T> T`	`body(Class<T> type)` Convert the HTTP body to the given type.
`<T> T`	`body(Type type)` Convert the HTTP body to the given type.
`<T> T`	`convert(ValueNode value, Class<T> type)` Converts a value (single or hash) into the given type.
`Value`	`cookie(String name)` Get a cookie matching the given name.
`Map<String,String>`	`cookieMap()` Request cookies.
`<T> T`	`decode(Type type, MediaType contentType)` Convert the HTTP body to the given type.
`MessageDecoder`	`decoder(MediaType contentType)` Get a decoder for the given content type or get an `StatusCode.UNSUPPORTED_MEDIA_TYPE`.
`Context`	`detach(Route.Handler next)` 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.
`FileUpload`	`file(String name)` A file upload that matches the given field name.
`List<FileUpload>`	`files()` All file uploads.
`List<FileUpload>`	`files(String name)` All file uploads that matches the given field name.
`FlashMap`	`flash()` Flash map.
`Value`	`flash(String name)` Get a flash attribute.
`Formdata`	`form()` Formdata as `ValueNode`.
`<T> T`	`form(Class<T> type)` Convert formdata to the given type.
`ValueNode`	`form(String name)` Form field that matches the given name.
`Map<String,String>`	`formMap()` Formdata as single-value map.
`Map<String,List<String>>`	`formMultimap()` Formdata as multi-value map.
`Context`	`forward(String path)` Forward executing to another route.
`Map<String,Object>`	`getAttributes()` Context attributes (a.k.a request attributes).
`default String`	`getContextPath()` Get application context path (a.k.a as base path).
`String`	`getHost()` Return the host that this request was sent to, in general this will be the value of the Host header, minus the port specifier.
`String`	`getHostAndPort()` Return the host and port that this request was sent to, in general this will be the value of the Host.
`String`	`getMethod()` HTTP method in upper-case form.
`int`	`getPort()` Return the port that this request was sent to.
`String`	`getProtocol()` The name of the protocol the request.
`String`	`getRemoteAddress()` The IP address of the client or last proxy that sent the request.
`long`	`getRequestLength()` Request `Content-Length` header or `-1` when missing.
`String`	`getRequestPath()` Request path without decoding (a.k.a raw Path) without query string.
`MediaType`	`getRequestType()` Request `Content-Type` header or `null` when missing.
`MediaType`	`getRequestType(MediaType defaults)` Request `Content-Type` header or `null` when missing.
`String`	`getRequestURL()` Recreates full/entire request url using the `Host` header.
`String`	`getRequestURL(String path)` Recreates full/entire request url using the `Host` header.
`boolean`	`getResetHeadersOnError()` True if response headers are cleared on application error.
`StatusCode`	`getResponseCode()` Get response status code.
`String`	`getResponseHeader(String name)` Get response header.
`long`	`getResponseLength()` Get response content length or `-1` when none was set.
`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.
`String`	`getServerHost()` Server host.
`int`	`getServerPort()` Server port for current request.
`<T> T`	`getUser()` Current user or `null` if none was set.
`ValueNode`	`header()` Request headers as `ValueNode`.
`Value`	`header(String name)` Get a header that matches the given name.
`Map<String,String>`	`headerMap()` Header as single-value map.
`Map<String,List<String>>`	`headerMultimap()` Header as multi-value map.
`boolean`	`isInIoThread()` True when request runs in IO threads.
`boolean`	`isResponseStarted()` True if response already started.
`boolean`	`isSecure()` Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
`boolean`	`matches(String pattern)` Check if the request path matches the given pattern.
`Multipart`	`multipart()` Get multipart data.
`<T> T`	`multipart(Class<T> type)` Convert multipart data to the given type.
`ValueNode`	`multipart(String name)` Get a multipart field that matches the given name.
`Map<String,String>`	`multipartMap()` Multipart data as single-value map.
`Map<String,List<String>>`	`multipartMultimap()` Multipart data as multi-value map.
`Context`	`onComplete(Route.Complete task)` Add a complete listener.
`ValueNode`	`path()` Convert `pathMap()` to a `ValueNode` object.
`<T> T`	`path(Class<T> type)` Convert the `pathMap()` to the given type.
`Value`	`path(String name)` Path variable.
`Map<String,String>`	`pathMap()` Path map represent all the path keys with their values.
`QueryString`	`query()` Query string as `ValueNode` object.
`<T> T`	`query(Class<T> type)` Convert the queryString to the given type.
`ValueNode`	`query(String name)` Get a query parameter that matches the given name.
`Map<String,String>`	`queryMap()` Query string as simple map.
`Map<String,List<String>>`	`queryMultimap()` Query string as multi-value map.
`String`	`queryString()` Query string with the leading `?` or empty string.
`static Context`	`readOnly(Context ctx)` Wrap a HTTP context and make read only.
`Context`	`removeResponseHeader(String name)` Remove a response header.
`Context`	`removeResponseHeaders()` Clear/reset all the headers, including cookies.
`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.
`OutputStream`	`responseStream(MediaType contentType)` HTTP response channel as output stream.
`Context`	`responseStream(MediaType contentType, SneakyThrows.Consumer<OutputStream> consumer)` HTTP response channel as output stream.
`Context`	`responseStream(SneakyThrows.Consumer<OutputStream> consumer)` HTTP response channel as output stream.
`PrintWriter`	`responseWriter()` HTTP response channel as response writer.
`PrintWriter`	`responseWriter(MediaType contentType)` HTTP response channel as response writer.
`PrintWriter`	`responseWriter(MediaType contentType, Charset charset)` HTTP response channel as response writer.
`Context`	`responseWriter(MediaType contentType, Charset charset, SneakyThrows.Consumer<PrintWriter> consumer)` HTTP response channel as response writer.
`Context`	`responseWriter(MediaType contentType, SneakyThrows.Consumer<PrintWriter> consumer)` HTTP response channel as response writer.
`Context`	`responseWriter(SneakyThrows.Consumer<PrintWriter> consumer)` HTTP response channel as response writer.
`Context`	`send(AttachedFile file)` Send a file attached response.
`Context`	`send(byte[]... data)` Send response data.
`Context`	`send(byte[] data)` Send response data.
`Context`	`send(ByteBuffer 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.
`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.
`Context`	`send(String data)` Send response data.
`Context`	`send(String data, Charset charset)` Send response data.
`Context`	`sendError(Throwable cause)` Send an error response.
`Context`	`sendError(Throwable cause, StatusCode statusCode)` Send an error response.
`Context`	`sendRedirect(StatusCode redirect, String location)` Send a redirect response.
`Context`	`sendRedirect(String location)` Send a `302` response.
`Session`	`session()` Find a session or creates a new session.
`Value`	`session(String name)` Find a session attribute using the given name.
`Session`	`sessionOrNull()` Find an existing session.
`Context`	`setDefaultResponseType(MediaType contentType)` Set the default response content type header.
`Context`	`setHost(String host)` Set the host (without the port value).
`Context`	`setMethod(String method)` Set HTTP method in upper-case form.
`Context`	`setPathMap(Map<String,String> pathMap)` Set path map.
`Context`	`setPort(int port)` Set port this request was sent to.
`Context`	`setRemoteAddress(String remoteAddress)` Set IP address of client or last proxy that sent the request.
`Context`	`setRequestPath(String path)` Set request path.
`Context`	`setResetHeadersOnError(boolean value)` Set whenever reset/clear headers on application error.
`Context`	`setResponseCode(int statusCode)` Set response status code.
`Context`	`setResponseCode(StatusCode statusCode)` Set response status code.
`Context`	`setResponseCookie(Cookie cookie)` Set/add a cookie to response.
`Context`	`setResponseHeader(String name, Date value)` Set response header.
`Context`	`setResponseHeader(String name, Instant value)` Set response header.
`Context`	`setResponseHeader(String name, Object value)` Set response header.
`Context`	`setResponseHeader(String name, String value)` Set response header.
`Context`	`setResponseLength(long length)` Set response content length header.
`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`	`setScheme(String scheme)` Set HTTP scheme in lower case.
`Context`	`setUser(Object user)` Set current user.
`Context`	`upgrade(ServerSentEmitter.Handler handler)` Perform a server-sent event handshake and upgrade HTTP GET into a Server-Sent protocol.
`Context`	`upgrade(WebSocket.Initializer handler)` Perform a websocket handsahke and upgrade a HTTP GET into a websocket protocol.
`static Context`	`websocket(Context ctx, WebSocket ws)` Wrap a HTTP context and make it WebSocket friendly.

Methods inherited from interface io.jooby.Registry
require, require, require

- Field Detail
  - PORT
```
static final int PORT
```
    Constant for default HTTP port.
    
    See Also:
    
    Constant Field Values
  - SECURE_PORT
```
static final int SECURE_PORT
```
    Constant for default HTTPS port.
    
    See Also:
    
    Constant Field Values
  - 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
<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
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.
  - forward
```
@Nonnull
Context forward(@Nonnull
                         String path)
```
    Forward executing to another route. We use the given path to find a matching route. NOTE: the entire handler pipeline is executed (filter, decorator, etc.).
    
    Parameters:
    
    path - Path to forward the request.
    
    Returns:
    
    This context.
  - convert
```
@Nullable
<T> T convert(@Nonnull
                        ValueNode value,
                        @Nonnull
                        Class<T> type)
```
    Converts a value (single or hash) into the given type.
    
    Type Parameters:
    
    T - Generic type.
    
    Parameters:
    
    value - Value to convert.
    
    type - Expected type.
    
    Returns:
    
    Converted value.
  - flash
```
@Nonnull
FlashMap flash()
```
    Flash map.
    
    Returns:
    
    Flash map.
  - flash
```
@Nonnull
Value flash(@Nonnull
                     String name)
```
    Get a flash attribute.
    
    Parameters:
    
    name - Attribute's name.
    
    Returns:
    
    Flash attribute.
  - session
```
@Nonnull
Session session()
```
    Find a session or creates a new session.
    
    Returns:
    
    Session.
  - session
```
@Nonnull
Value session(@Nonnull
                       String name)
```
    Find a session attribute using the given name. If there is no session or attribute under that name a missing value is returned.
    
    Parameters:
    
    name - Attribute's name.
    
    Returns:
    
    Session's attribute or missing.
  - sessionOrNull
```
@Nullable
Session sessionOrNull()
```
    Find an existing session.
    
    Returns:
    
    Existing session or null.
  - cookie
```
@Nonnull
Value cookie(@Nonnull
                      String name)
```
    Get a cookie matching the given name.
    
    Parameters:
    
    name - Cookie's name.
    
    Returns:
    
    Cookie value.
  - cookieMap
```
@Nonnull
Map<String,String> cookieMap()
```
    Request cookies.
    
    Returns:
    
    Request cookies.
  - getMethod
```
@Nonnull
String getMethod()
```
    HTTP method in upper-case form.
    
    Returns:
    
    HTTP method in upper-case form.
  - setMethod
```
@Nonnull
Context setMethod(@Nonnull
                           String method)
```
    Set HTTP method in upper-case form.
    
    Parameters:
    
    method - HTTP method in upper-case form.
    
    Returns:
    
    This context.
  - getRoute
```
@Nonnull
Route getRoute()
```
    Matching route.
    
    Returns:
    
    Matching route.
  - matches
```
boolean matches(@Nonnull
                String pattern)
```
    Check if the request path matches the given pattern.
    
    Parameters:
    
    pattern - Pattern to use.
    
    Returns:
    
    True if request path matches the pattern.
  - 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.
  - getContextPath
```
@Nonnull
default String getContextPath()
```
    Get application context path (a.k.a as base path).
    
    Returns:
    
    Application context path (a.k.a as base path).
  - getRequestPath
```
@Nonnull
String getRequestPath()
```
    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.
  - setRequestPath
```
@Nonnull
Context setRequestPath(@Nonnull
                                String path)
```
    Set request path. This is usually done by Web Server or framework, but by user.
    
    Parameters:
    
    path - Request path.
    
    Returns:
    
    This context.
  - path
```
@Nonnull
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
<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
ValueNode path()
```
    Convert pathMap() to a ValueNode 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 ValueNode object.
    
    Returns:
    
    Query string as ValueNode object.
  - query
```
@Nonnull
ValueNode 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
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
<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
Map<String,String> queryMap()
```
    Query string as simple map.
    Produces
```
{q: jooby, sort: name}
```
    Returns:
    
    Query string as map.
  - queryMultimap
```
@Nonnull
Map<String,List<String>> queryMultimap()
```
    Query string as multi-value map.
    Produces
```
{q: [jooby], sort: [name, id]}
```
    Returns:
    
    Query string as map.
  - header
```
@Nonnull
ValueNode header()
```
    Request headers as ValueNode.
    
    Returns:
    
    Request headers as ValueNode.
  - header
```
@Nonnull
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
Map<String,String> headerMap()
```
    Header as single-value map.
    
    Returns:
    
    Header as single-value map.
  - headerMultimap
```
@Nonnull
Map<String,List<String>> headerMultimap()
```
    Header as multi-value map.
    
    Returns:
    
    Header as multi-value map.
  - accept
```
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
```
@Nullable
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
MediaType getRequestType()
```
    Request Content-Type header or null when missing.
    
    Returns:
    
    Request Content-Type header or null when missing.
  - getRequestType
```
@Nonnull
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
```
long getRequestLength()
```
    Request Content-Length header or -1 when missing.
    
    Returns:
    
    Request Content-Length header or -1 when missing.
  - getUser
```
@Nullable
<T> T getUser()
```
    Current user or null if none was set.
    
    Type Parameters:
    
    T - User type.
    
    Returns:
    
    Current user or null if none was set.
  - setUser
```
@Nonnull
Context setUser(@Nullable
                         Object user)
```
    Set current user.
    
    Parameters:
    
    user - Current user.
    
    Returns:
    
    This context.
  - getRequestURL
```
@Nonnull
String getRequestURL()
```
    Recreates full/entire request url using the Host header. If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header, please consider to set Router.setTrustProxy(boolean) option.
    
    Returns:
    
    Full/entire request url using the Host header.
  - getRequestURL
```
@Nonnull
String getRequestURL(@Nonnull
                              String path)
```
    Recreates full/entire request url using the Host header. If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header, please consider to set Router.setTrustProxy(boolean) option.
    
    Parameters:
    
    path - Path to use.
    
    Returns:
    
    Full/entire request url using the Host header.
  - getRemoteAddress
```
@Nonnull
String getRemoteAddress()
```
    The IP address of the client or last proxy that sent the request. If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header, please consider to set Router.setTrustProxy(boolean) option.
    
    Returns:
    
    The IP address of the client or last proxy that sent the request.
  - setRemoteAddress
```
@Nonnull
Context setRemoteAddress(@Nonnull
                                  String remoteAddress)
```
    Set IP address of client or last proxy that sent the request.
    
    Parameters:
    
    remoteAddress - Remote Address.
    
    Returns:
    
    This context.
  - getHost
```
@Nonnull
String getHost()
```
    Return the host that this request was sent to, in general this will be the value of the Host header, minus the port specifier. Unless, it is set manually using the setHost(String) method. If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header, please consider to set Router.setTrustProxy(boolean) option.
    
    Returns:
    
    Return the host that this request was sent to, in general this will be the value of the Host header, minus the port specifier.
  - setHost
```
@Nonnull
Context setHost(@Nonnull
                         String host)
```
    Set the host (without the port value). Please keep in mind this method doesn't alter/modify the host header.
    
    Parameters:
    
    host - Host value.
    
    Returns:
    
    This context.
  - getHostAndPort
```
@Nonnull
String getHostAndPort()
```
    Return the host and port that this request was sent to, in general this will be the value of the Host. If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header, please consider to set Router.setTrustProxy(boolean) option.
    
    Returns:
    
    Return the host that this request was sent to, in general this will be the value of the Host header.
  - getPort
```
int getPort()
```
    Return the port that this request was sent to. In general this will be the value of the Host header, minus the host name. If no host header is present, this method returns the value of getServerPort().
    
    Returns:
    
    Return the port that this request was sent to. In general this will be the value of the Host header, minus the host name.
  - setPort
```
@Nonnull
Context setPort(int port)
```
    Set port this request was sent to.
    
    Parameters:
    
    port - Port.
    
    Returns:
    
    This context.
  - 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.
  - getServerPort
```
int getServerPort()
```
    Server port for current request.
    
    Returns:
    
    Server port for current request.
  - getServerHost
```
@Nonnull
String getServerHost()
```
    Server host.
    
    Returns:
    
    Server host.
  - isSecure
```
boolean isSecure()
```
    Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
    
    Returns:
    
    a boolean indicating if the request was made using a secure channel
  - getScheme
```
@Nonnull
String getScheme()
```
    HTTP scheme in lower case.
    
    Returns:
    
    HTTP scheme in lower case.
  - setScheme
```
@Nonnull
Context setScheme(@Nonnull
                           String scheme)
```
    Set HTTP scheme in lower case.
    
    Parameters:
    
    scheme - HTTP scheme in lower case.
    
    Returns:
    
    This context.
  - form
```
@Nonnull
Formdata form()
```
    Formdata as ValueNode. This method is for application/form-url-encoded request.
    
    Returns:
    
    Formdata as ValueNode. This method is for application/form-url-encoded request.
  - formMultimap
```
@Nonnull
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
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
ValueNode 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
<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
ValueNode multipart(@Nonnull
                             String name)
```
    Get a multipart field that matches the given name. File upload retrieval is available using file(String). Only for multipart/form-data request.
    
    Parameters:
    
    name - Field name.
    
    Returns:
    
    Multipart value.
  - multipart
```
@Nonnull
<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
Map<String,List<String>> multipartMultimap()
```
    Multipart data as multi-value map. Only for multipart/form-data request.
    
    Returns:
    
    Multi-value map.
  - multipartMap
```
@Nonnull
Map<String,String> multipartMap()
```
    Multipart data as single-value map. Only for multipart/form-data request.
    
    Returns:
    
    Single-value map.
  - files
```
@Nonnull
List<FileUpload> files()
```
    All file uploads. Only for multipart/form-data request.
    
    Returns:
    
    All file uploads.
  - files
```
@Nonnull
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
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
<T> T body(@Nonnull
                    Class<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
<T> T body(@Nonnull
                    Type type)
```
    Convert the HTTP body to the given type.
    
    Type Parameters:
    
    T - Conversion type.
    
    Parameters:
    
    type - Reified type.
    
    Returns:
    
    Instance of conversion type.
  - decode
```
@Nonnull
<T> T decode(@Nonnull
                      Type type,
                      @Nonnull
                      MediaType contentType)
```
    Convert the HTTP body to the given type.
    
    Type Parameters:
    
    T - Conversion type.
    
    Parameters:
    
    type - Generic type.
    
    contentType - Content type to use.
    
    Returns:
    
    Instance of conversion type.
  - decoder
```
@Nonnull
MessageDecoder decoder(@Nonnull
                                MediaType contentType)
```
    Get a decoder for the given content type or get an StatusCode.UNSUPPORTED_MEDIA_TYPE.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    MessageDecoder.
  - 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
                        Route.Handler next)
                 throws Exception
```
    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 operation integrates easily with third-party libraries like rxJava or others.
    
    Parameters:
    
    next - Application code.
    
    Returns:
    
    This context.
    
    Throws:
    
    Exception - When detach operation fails.
  - upgrade
```
@Nonnull
Context upgrade(@Nonnull
                         WebSocket.Initializer handler)
```
    Perform a websocket handsahke and upgrade a HTTP GET into a websocket protocol. NOTE: This method is part of Public API, but shouldn't be used by client code.
    
    Parameters:
    
    handler - Web socket initializer.
    
    Returns:
    
    This context.
  - upgrade
```
@Nonnull
Context upgrade(@Nonnull
                         ServerSentEmitter.Handler handler)
```
    Perform a server-sent event handshake and upgrade HTTP GET into a Server-Sent protocol. NOTE: This method is part of Public API, but shouldn't be used by client code.
    
    Parameters:
    
    handler - Server-Sent event handler.
    
    Returns:
    
    This context.
  - setResponseHeader
```
@Nonnull
Context setResponseHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Date value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setResponseHeader
```
@Nonnull
Context setResponseHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Instant value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setResponseHeader
```
@Nonnull
Context setResponseHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Object value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - setResponseHeader
```
@Nonnull
Context setResponseHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   String value)
```
    Set response header.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
    
    Returns:
    
    This context.
  - removeResponseHeader
```
@Nonnull
Context removeResponseHeader(@Nonnull
                                      String name)
```
    Remove a response header.
    
    Parameters:
    
    name - Header's name.
    
    Returns:
    
    This context.
  - removeResponseHeaders
```
@Nonnull
Context removeResponseHeaders()
```
    Clear/reset all the headers, including cookies.
    
    Returns:
    
    This context.
  - setResponseLength
```
@Nonnull
Context setResponseLength(long length)
```
    Set response content length header.
    
    Parameters:
    
    length - Response length.
    
    Returns:
    
    This context.
  - getResponseHeader
```
@Nullable
String getResponseHeader(@Nonnull
                                   String name)
```
    Get response header.
    
    Parameters:
    
    name - Header's name.
    
    Returns:
    
    Header's value (if set previously) or null.
  - getResponseLength
```
long getResponseLength()
```
    Get response content length or -1 when none was set.
    
    Returns:
    
    Response content length or -1 when none was set.
  - setResponseCookie
```
@Nonnull
Context setResponseCookie(@Nonnull
                                   Cookie cookie)
```
    Set/add a cookie to response.
    
    Parameters:
    
    cookie - Cookie to add.
    
    Returns:
    
    This context.
  - setResponseType
```
@Nonnull
Context setResponseType(@Nonnull
                                 String contentType)
```
    Set response content type header.
    
    Parameters:
    
    contentType - Content type.
    
    Returns:
    
    This context.
  - setResponseType
```
@Nonnull
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.
  - setResponseCode
```
@Nonnull
Context setResponseCode(@Nonnull
                                 StatusCode statusCode)
```
    Set response status code.
    
    Parameters:
    
    statusCode - Status code.
    
    Returns:
    
    This context.
  - setResponseCode
```
@Nonnull
Context setResponseCode(int statusCode)
```
    Set response status code.
    
    Parameters:
    
    statusCode - Status code.
    
    Returns:
    
    This context.
  - getResponseCode
```
@Nonnull
StatusCode getResponseCode()
```
    Get response status code.
    
    Returns:
    
    Response status code.
  - render
```
@Nonnull
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
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
Context responseStream(@Nonnull
                                MediaType contentType,
                                @Nonnull
                                SneakyThrows.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
Context responseStream(@Nonnull
                                SneakyThrows.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
PrintWriter responseWriter()
```
    HTTP response channel as response writer.
    
    Returns:
    
    HTTP channel as response writer. Usually for chunked response.
  - responseWriter
```
@Nonnull
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
Context responseWriter(@Nonnull
                                SneakyThrows.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
Context responseWriter(@Nonnull
                                MediaType contentType,
                                @Nonnull
                                SneakyThrows.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
Context responseWriter(@Nonnull
                                MediaType contentType,
                                @Nullable
                                Charset charset,
                                @Nonnull
                                SneakyThrows.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
Context sendRedirect(@Nonnull
                              String location)
```
    Send a 302 response.
    
    Parameters:
    
    location - Location.
    
    Returns:
    
    This context.
  - sendRedirect
```
@Nonnull
Context sendRedirect(@Nonnull
                              StatusCode redirect,
                              @Nonnull
                              String location)
```
    Send a redirect response.
    
    Parameters:
    
    redirect - Redirect status code.
    
    location - Location.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
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
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
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
Context send(@Nonnull
                      AttachedFile file)
```
    Send a file attached response.
    
    Parameters:
    
    file - Attached file.
    
    Returns:
    
    This context.
  - send
```
@Nonnull
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
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
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.
  - getResetHeadersOnError
```
boolean getResetHeadersOnError()
```
    True if response headers are cleared on application error. If none set it uses the default/global value specified by RouterOption.RESET_HEADERS_ON_ERROR.
    
    Returns:
    
    True if response headers are cleared on application error. If none set it uses the default/global value specified by RouterOption.RESET_HEADERS_ON_ERROR.
  - setResetHeadersOnError
```
@Nonnull
Context setResetHeadersOnError(boolean value)
```
    Set whenever reset/clear headers on application error.
    
    Parameters:
    
    value - True for reset/clear headers.
    
    Returns:
    
    This context.
  - onComplete
```
@Nonnull
Context onComplete(@Nonnull
                            Route.Complete task)
```
    Add a complete listener.
    
    Parameters:
    
    task - Task to execute.
    
    Returns:
    
    This context.
  - readOnly
```
@Nonnull
static Context readOnly(@Nonnull
                                 Context ctx)
```
    Wrap a HTTP context and make read only. Attempt to modify the HTTP response resulted in exception.
    
    Parameters:
    
    ctx - Originating context.
    
    Returns:
    
    Read only context.
  - websocket
```
@Nonnull
static Context websocket(@Nonnull
                                  Context ctx,
                                  @Nonnull
                                  WebSocket ws)
```
    Wrap a HTTP context and make it WebSocket friendly. Attempt to modify the HTTP response is completely ignored, except for send(byte[]) and send(String) which are delegated to the given web socket. This context is necessary for creating a bridge between MessageEncoder and WebSocket. This method is part of Public API, but direct usage is discourage.
    
    Parameters:
    
    ctx - Originating context.
    
    ws - WebSocket.
    
    Returns:
    
    Read only context.

Interface Context

Field Summary

Method Summary

Methods inherited from interface io.jooby.Registry

Field Detail

PORT

SECURE_PORT

ACCEPT

GMT

RFC1123_PATTERN

RFC1123

Method Detail

getAttributes

attribute

attribute

getRouter

forward

convert

flash

flash

session

session

sessionOrNull

cookie

cookieMap

getMethod

setMethod

getRoute

matches

setRoute

getContextPath

getRequestPath

setRequestPath

path

path

path

pathMap

setPathMap

query

query

queryString

query

queryMap

queryMultimap

header

header

headerMap

headerMultimap

accept

accept

getRequestType

getRequestType

getRequestLength

getUser

setUser

getRequestURL

getRequestURL

getRemoteAddress

setRemoteAddress

getHost

setHost

getHostAndPort

getPort

setPort

getProtocol

getServerPort

getServerHost

isSecure

getScheme

setScheme

form

formMultimap

formMap

form

form

multipart

multipart

multipart

multipartMultimap

multipartMap