io.jooby

Interface Context

public interface Context

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT
static ZoneId	GMT
static DateTimeFormatter	RFC1123
static String	RFC1123_PATTERN

Method Summary

Modifier and Type	Method and Description
default boolean	accept(MediaType contentType)
Body	body()
default <T> T	body(Class type)
default <T> T	body(Class type, MediaType contentType)
default <T> T	body(Reified<T> type)
default <T> T	body(Reified<T> type, MediaType contentType)
Context	detach(Runnable action)
Context	dispatch(Executor executor, Runnable action)
Context	dispatch(Runnable action)
default FileUpload	file(String name)
default List<FileUpload>	files()
default List<FileUpload>	files(String name)
Formdata	form()
default <T> T	form(Class<T> type)
default <T> T	form(Reified<T> type)
default Value	form(String name)
default Map<String,String>	formMap()
default Map<String,List<String>>	formMultimap()
AttributeMap	getAttributes()
default long	getContentLength()
default MediaType	getContentType()
default String	getHostname()
String	getMethod()
String	getProtocol()
String	getRemoteAddress()
MediaType	getResponseContentType()
Route	getRoute()
Router	getRouter()
String	getServerName() Name of the underlying HTTP server: netty, utow, jetty, etc..
StatusCode	getStatusCode()
default Value	header(String name)
default Map<String,String>	headerMap()
default Map<String,List<String>>	headerMultimap()
Value	headers()
boolean	isInIoThread()
boolean	isResponseStarted()
Multipart	multipart() Parse a multipart/form-data request and returns the result.
default <T> T	multipart(Class<T> type)
default <T> T	multipart(Reified<T> type)
default Value	multipart(String name)
default Map<String,String>	multipartMap()
default Map<String,List<String>>	multipartMultimap()
default Parser	parser(MediaType contentType)
default Value	path()
default <T> T	path(Class<T> type)
default <T> T	path(Reified<T> type)
default Value	path(String name)
Map<String,String>	pathMap()
String	pathString() Request path without decoding (a.k.a raw Path).
QueryString	query()
default <T> T	query(Class<T> type)
default <T> T	query(Reified<T> type)
default Value	query(String name)
default Map<String,String>	queryMap()
default Map<String,List<String>>	queryMultimap()
default String	queryString() Query string with the leading ? or empty string.
default Context	render(Object value)
Sender	responseSender()
OutputStream	responseStream()
default OutputStream	responseStream(MediaType contentType)
default Context	responseStream(MediaType contentType, Throwing.Consumer<OutputStream> consumer)
default Context	responseStream(Throwing.Consumer<OutputStream> consumer)
default PrintWriter	responseWriter()
default PrintWriter	responseWriter(MediaType contentType)
PrintWriter	responseWriter(MediaType contentType, Charset charset)
default Context	responseWriter(MediaType contentType, Charset charset, Throwing.Consumer<PrintWriter> consumer)
default Context	responseWriter(MediaType contentType, Throwing.Consumer<PrintWriter> consumer)
default Context	responseWriter(Throwing.Consumer<PrintWriter> consumer)
default Context	sendAttachment(AttachedFile file)
Context	sendBytes(byte[] data)
default Context	sendBytes(io.netty.buffer.ByteBuf data)
Context	sendBytes(ByteBuffer data)
Context	sendBytes(ReadableByteChannel channel)
default Context	sendError(Throwable cause)
default Context	sendError(Throwable cause, StatusCode statusCode)
Context	sendFile(FileChannel file)
default Context	sendFile(Path file)
default Context	sendRedirect(StatusCode redirect, String location)
default Context	sendRedirect(String location)
Context	sendStatusCode(int statusCode)
default Context	sendStatusCode(StatusCode statusCode)
Context	sendStream(InputStream input)
default Context	sendString(String data)
Context	sendString(String data, Charset charset)
Context	setContentLength(long length)
default Context	setContentType(MediaType contentType)
Context	setContentType(MediaType contentType, Charset charset)
Context	setContentType(String contentType)
Context	setDefaultContentType(MediaType contentType)
default Context	setHeader(String name, Date value)
default Context	setHeader(String name, Instant value)
default Context	setHeader(String name, Object value)
Context	setHeader(String name, String value)
Context	setPathMap(Map<String,String> pathMap)
Context	setRoute(Route route)
Context	setStatusCode(int statusCode)
default Context	setStatusCode(StatusCode statusCode)

Field Detail

ACCEPT

static final String ACCEPT

See Also:

Constant Field Values

GMT

static final ZoneId GMT

RFC1123_PATTERN

static final String RFC1123_PATTERN

See Also:

Constant Field Values

RFC1123

static final DateTimeFormatter RFC1123

Method Detail

getAttributes

@Nonnull
AttributeMap getAttributes()

getRouter

@Nonnull
Router getRouter()

getMethod

@Nonnull
String getMethod()

getRoute

@Nonnull
Route getRoute()

setRoute

@Nonnull
Context setRoute(@Nonnull
                          Route route)

pathString

@Nonnull
String pathString()

Request path without decoding (a.k.a raw Path). QueryString (if any) is not included.

Returns:

Request path without decoding (a.k.a raw Path). QueryString (if any) is not included.

path

@Nonnull
default Value path(@Nonnull
                            String name)

path

@Nonnull
default <T> T path(@Nonnull
                            Reified<T> type)

path

@Nonnull
default <T> T path(@Nonnull
                            Class<T> type)

path

@Nonnull
default Value path()

pathMap

@Nonnull
Map<String,String> pathMap()

setPathMap

@Nonnull
Context setPathMap(@Nonnull
                            Map<String,String> pathMap)

query

@Nonnull
QueryString query()

query

@Nonnull
default Value query(@Nonnull
                             String name)

queryString

@Nonnull
default String queryString()

Query string with the leading ? or empty string.

Returns:

Query string with the leading ? or empty string.

query

@Nonnull
default <T> T query(@Nonnull
                             Reified<T> type)

query

@Nonnull
default <T> T query(@Nonnull
                             Class<T> type)

queryMap

@Nonnull
default Map<String,String> queryMap()

queryMultimap

@Nonnull
default Map<String,List<String>> queryMultimap()

headers

@Nonnull
Value headers()

header

@Nonnull
default Value header(@Nonnull
                              String name)

headerMap

@Nonnull
default Map<String,String> headerMap()

headerMultimap

@Nonnull
default Map<String,List<String>> headerMultimap()

accept

default boolean accept(@Nonnull
                       MediaType contentType)

getContentType

@Nullable
default MediaType getContentType()

getContentLength

default long getContentLength()

getRemoteAddress

@Nonnull
String getRemoteAddress()

getHostname

@Nonnull
default String getHostname()

getProtocol

@Nonnull
String getProtocol()

form

@Nonnull
Formdata form()

formMultimap

@Nonnull
default Map<String,List<String>> formMultimap()

formMap

@Nonnull
default Map<String,String> formMap()

form

@Nonnull
default Value form(@Nonnull
                            String name)

form

@Nonnull
default <T> T form(@Nonnull
                            Reified<T> type)

form

@Nonnull
default <T> T form(@Nonnull
                            Class<T> type)

multipart

@Nonnull
Multipart multipart()

Parse a multipart/form-data request and returns the result. NOTE: this method throws an IllegalStateException when call it from EVENT_LOOP thread;

Returns:

Multipart node.

multipart

@Nonnull
default Value multipart(@Nonnull
                                 String name)

multipart

@Nonnull
default <T> T multipart(@Nonnull
                                 Reified<T> type)

multipart

@Nonnull
default <T> T multipart(@Nonnull
                                 Class<T> type)

multipartMultimap

@Nonnull
default Map<String,List<String>> multipartMultimap()

multipartMap

@Nonnull
default Map<String,String> multipartMap()

files

@Nonnull
default List<FileUpload> files()

files

@Nonnull
default List<FileUpload> files(@Nonnull
                                        String name)

file

@Nonnull
default FileUpload file(@Nonnull
                                 String name)

body

@Nonnull
Body body()

body

@Nonnull
default <T> T body(@Nonnull
                            Reified<T> type)

body

@Nonnull
default <T> T body(@Nonnull
                            Reified<T> type,
                            @Nonnull
                            MediaType contentType)

body

@Nonnull
default <T> T body(@Nonnull
                            Class type)

body

@Nonnull
default <T> T body(@Nonnull
                            Class type,
                            @Nonnull
                            MediaType contentType)

parser

@Nonnull
default Parser parser(@Nonnull
                               MediaType contentType)

isInIoThread

boolean isInIoThread()

dispatch

@Nonnull
Context dispatch(@Nonnull
                          Runnable action)

dispatch

@Nonnull
Context dispatch(@Nonnull
                          Executor executor,
                          @Nonnull
                          Runnable action)

detach

@Nonnull
Context detach(@Nonnull
                        Runnable action)

setHeader

@Nonnull
default Context setHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Date value)

setHeader

@Nonnull
default Context setHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Instant value)

setHeader

@Nonnull
default Context setHeader(@Nonnull
                                   String name,
                                   @Nonnull
                                   Object value)

setHeader

@Nonnull
Context setHeader(@Nonnull
                           String name,
                           @Nonnull
                           String value)

setContentLength

@Nonnull
Context setContentLength(long length)

setContentType

@Nonnull
Context setContentType(@Nonnull
                                String contentType)

setContentType

@Nonnull
default Context setContentType(@Nonnull
                                        MediaType contentType)

setContentType

@Nonnull
Context setContentType(@Nonnull
                                MediaType contentType,
                                @Nullable
                                Charset charset)

setDefaultContentType

@Nonnull
Context setDefaultContentType(@Nonnull
                                       MediaType contentType)

getResponseContentType

@Nonnull
MediaType getResponseContentType()

setStatusCode

@Nonnull
default Context setStatusCode(@Nonnull
                                       StatusCode statusCode)

setStatusCode

@Nonnull
Context setStatusCode(int statusCode)

getStatusCode

@Nonnull
StatusCode getStatusCode()

render

@Nonnull
default Context render(@Nonnull
                                Object value)

responseStream

@Nonnull
OutputStream responseStream()

responseStream

@Nonnull
default OutputStream responseStream(@Nonnull
                                             MediaType contentType)

responseStream

@Nonnull
default Context responseStream(@Nonnull
                                        MediaType contentType,
                                        @Nonnull
                                        Throwing.Consumer<OutputStream> consumer)
                                 throws Exception

Throws:

Exception

responseStream

@Nonnull
default Context responseStream(@Nonnull
                                        Throwing.Consumer<OutputStream> consumer)
                                 throws Exception

Throws:

Exception

responseSender

@Nonnull
Sender responseSender()

responseWriter

@Nonnull
default PrintWriter responseWriter()

responseWriter

@Nonnull
default PrintWriter responseWriter(@Nonnull
                                            MediaType contentType)

responseWriter

@Nonnull
PrintWriter responseWriter(@Nonnull
                                    MediaType contentType,
                                    @Nullable
                                    Charset charset)

responseWriter

@Nonnull
default Context responseWriter(@Nonnull
                                        Throwing.Consumer<PrintWriter> consumer)
                                 throws Exception

Throws:

Exception

responseWriter

@Nonnull
default Context responseWriter(@Nonnull
                                        MediaType contentType,
                                        @Nonnull
                                        Throwing.Consumer<PrintWriter> consumer)
                                 throws Exception

Throws:

Exception

responseWriter

@Nonnull
default Context responseWriter(@Nonnull
                                        MediaType contentType,
                                        @Nullable
                                        Charset charset,
                                        @Nonnull
                                        Throwing.Consumer<PrintWriter> consumer)
                                 throws Exception

Throws:

Exception

sendRedirect

@Nonnull
default Context sendRedirect(@Nonnull
                                      String location)

sendRedirect

@Nonnull
default Context sendRedirect(@Nonnull
                                      StatusCode redirect,
                                      @Nonnull
                                      String location)

sendString

@Nonnull
default Context sendString(@Nonnull
                                    String data)

sendString

@Nonnull
Context sendString(@Nonnull
                            String data,
                            @Nonnull
                            Charset charset)

sendBytes

@Nonnull
Context sendBytes(@Nonnull
                           byte[] data)

sendBytes

@Nonnull
Context sendBytes(@Nonnull
                           ByteBuffer data)

sendBytes

@Nonnull
default Context sendBytes(@Nonnull
                                   io.netty.buffer.ByteBuf data)

sendBytes

@Nonnull
Context sendBytes(@Nonnull
                           ReadableByteChannel channel)

sendStream

@Nonnull
Context sendStream(@Nonnull
                            InputStream input)

sendAttachment

@Nonnull
default Context sendAttachment(@Nonnull
                                        AttachedFile file)

sendFile

@Nonnull
default Context sendFile(@Nonnull
                                  Path file)

sendFile

@Nonnull
Context sendFile(@Nonnull
                          FileChannel file)

sendStatusCode

@Nonnull
default Context sendStatusCode(@Nonnull
                                        StatusCode statusCode)

sendStatusCode

@Nonnull
Context sendStatusCode(int statusCode)

sendError

@Nonnull
default Context sendError(@Nonnull
                                   Throwable cause)

sendError

@Nonnull
default Context sendError(@Nonnull
                                   Throwable cause,
                                   @Nonnull
                                   StatusCode statusCode)

isResponseStarted

boolean isResponseStarted()

getServerName

@Nonnull
String getServerName()

Name of the underlying HTTP server: netty, utow, jetty, etc..

Returns:

Name of the underlying HTTP server: netty, utow, jetty, etc..