org.jooby.spi

Interface NativeRequest

public interface NativeRequest

Minimal/basic implementation of HTTP request. A server implementor must provide an implementation of NativeRequest.

Since:

0.5.0

Author:

edgar

Method Summary

Modifier and Type	Method and Description
default Map<String,Object>	attributes()
List<Cookie>	cookies()
List<NativeUpload>	files() Get all the files or an empty list.
List<NativeUpload>	files(String name) Get all the files for the provided name or an empty list.
Optional<String>	header(String name) Get the first header for the provided name or a empty list.
List<String>	headerNames()
List<String>	headers(String name) Get all the headers for the provided name or a empty list.
InputStream	in() Input stream that represent the body.
String	ip()
String	method()
List<String>	paramNames()
List<String>	params(String name) Get all the params for the provided name or a empty list.
String	path()
String	protocol()
default void	push(String method, String path, Map<String,Object> headers) Send push promise to the client.
Optional<String>	queryString() Returns the query string that is contained in the request URL after the path.
String	rawPath()
boolean	secure()
void	startAsync(Executor executor, Runnable runnable) Put the request in async mode.
<T> T	upgrade(Class<T> type) Upgrade the request to something else...like a web socket.

Method Detail

method

String method()

Returns:

The name of the HTTP method with which this request was made, for example, GET, POST, or PUT.

path

String path()

Returns:

The part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.

queryString

Optional<String> queryString()

Returns the query string that is contained in the request URL after the path.

Returns:

Query string or empty

paramNames

List<String> paramNames()
                 throws Exception

Returns:

List with all the parameter names from query string plus any other form/multipart param names (excluding file uploads). This method should NOT returns null, absence of params is represented by an empty list.

Throws:

Exception - If param extraction fails.

params

List<String> params(String name)
             throws Exception

Get all the params for the provided name or a empty list.

Parameters:

name - Parameter name.

Returns:

Get all the params for the provided name or a empty list.

Throws:

Exception - If param parsing fails.

attributes

default Map<String,Object> attributes()

Returns:

Map containing all request attributes

headers

List<String> headers(String name)

Get all the headers for the provided name or a empty list.

Parameters:

name - Header name.

Returns:

Get all the headers for the provided name or a empty list.

header

Optional<String> header(String name)

Get the first header for the provided name or a empty list.

Parameters:

name - Header name.

Returns:

The first header for the provided name or a empty list.

headerNames

List<String> headerNames()

Returns:

All the header names or an empty list.

cookies

List<Cookie> cookies()

Returns:

All the cookies or an empty list.

files

List<NativeUpload> files(String name)
                  throws IOException

Get all the files for the provided name or an empty list.

Parameters:

name - File name.

Returns:

All the files or an empty list.

Throws:

IOException - If file parsing fails.

files

List<NativeUpload> files()
                  throws IOException

Get all the files or an empty list.

Returns:

All the files or an empty list.

Throws:

IOException - If file parsing fails.

in

InputStream in()
        throws IOException

Input stream that represent the body.

Returns:

Body as an input stream.

Throws:

IOException - If body read fails.

ip

String ip()

Returns:

The IP address of the client or last proxy that sent the request.

protocol

String protocol()

Returns:

The name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1

secure

boolean secure()

Returns:

True if this request was made using a secure channel, such as HTTPS.

upgrade

<T> T upgrade(Class<T> type)
       throws Exception

Upgrade the request to something else...like a web socket.

Type Parameters:

T - Upgrade type.

Parameters:

type - Upgrade type.

Returns:

A instance of the upgrade.

Throws:

Exception - If the upgrade fails or it is un-supported.

See Also:

NativeWebSocket

startAsync

void startAsync(Executor executor,
                Runnable runnable)

Put the request in async mode.

Parameters:

executor - Executor to use.

runnable - Task to run.

push

default void push(String method,
                  String path,
                  Map<String,Object> headers)
           throws Exception

Send push promise to the client.

Parameters:

method - HTTP method.

path - HTTP path.

headers - HTTP headers.

Throws:

Exception - If something goes wrong.

rawPath

String rawPath()

Returns:

Request path without decoding.