org.cauli.server

接口 HttpRequest

所有超级接口:

DataHolder

所有已知实现类:

HttpRequestWrapper, NettyHttpRequest, StubHttpRequest

public interface HttpRequest
extends DataHolder

Retrieves information about inbound HTTP request.

作者:

Joe Walnes

另请参阅:

HttpHandler, HttpResponse

字段概要

字段

限定符和类型	字段和说明
static String	COOKIE_HEADER

方法概要

方法

限定符和类型	方法和说明
List<Map.Entry<String,String>>	allHeaders() Returns all headers sent from client.
String	body() The body
byte[]	bodyAsBytes() The body's byte array
HttpCookie	cookie(String name) Get a cookie with a specific name
List<HttpCookie>	cookies()
String	cookieValue(String name) Get the value of named cookie
HttpRequest	data(String key, Object value) Store data value by key.
boolean	hasHeader(String name) Whether a specific HTTP header was present in the request.
String	header(String name) Retrieve the value single HTTP header.
List<String>	headers(String name) Retrieve all values for an HTTP header.
Object	id() A unique identifier for this request.
String	method() HTTP method (e.g.
String	postParam(String key) Get post parameter value.
Set<String>	postParamKeys() List all post parameter keys.
List<String>	postParams(String key) Get all post parameter values.
String	queryParam(String key) Get query parameter value.
Set<String>	queryParamKeys() List all query parameter keys.
List<String>	queryParams(String key) Get all query parameter values.
SocketAddress	remoteAddress() Remote address of connection (i.e. the host of the client).
long	timestamp() Timestamp (millis since epoch) of when this request was first received by the server.
String	uri()
HttpRequest	uri(String uri) Modify uri

从接口继承的方法 org.cauli.server.DataHolder

data, data, dataKeys

字段详细资料

COOKIE_HEADER

static final String COOKIE_HEADER

另请参阅:

常量字段值

方法详细资料

uri

String uri()

uri

HttpRequest uri(String uri)

Modify uri

参数:

uri - new uri

header

String header(String name)

Retrieve the value single HTTP header.

If the header is not found, null is returned.

If there are multiple headers with the same name, it will return one of them, but it is not defined which one. Instead, use headers(String).

headers

List<String> headers(String name)

Retrieve all values for an HTTP header. If no values are found, an empty List is returned.

hasHeader

boolean hasHeader(String name)

Whether a specific HTTP header was present in the request.

cookies

List<HttpCookie> cookies()

返回:

all inbound cookies

cookie

HttpCookie cookie(String name)

Get a cookie with a specific name

参数:

name - cookie name

返回:

cookie with that name

queryParam

String queryParam(String key)

Get query parameter value.

参数:

key - parameter name

返回:

the value of the parameter

另请参阅:

queryParams(String)

queryParams

List<String> queryParams(String key)

Get all query parameter values.

参数:

key - parameter name

返回:

the values of the parameter

另请参阅:

queryParam(String)

queryParamKeys

Set<String> queryParamKeys()

List all query parameter keys.

另请参阅:

queryParam(String)

postParam

String postParam(String key)

Get post parameter value.

参数:

key - parameter name

返回:

the value of the parameter

另请参阅:

postParams(String)

postParams

List<String> postParams(String key)

Get all post parameter values.

参数:

key - parameter name

返回:

the values of the parameter

另请参阅:

postParam(String)

postParamKeys

Set<String> postParamKeys()

List all post parameter keys.

另请参阅:

postParam(String)

cookieValue

String cookieValue(String name)

Get the value of named cookie

参数:

name - cookie name

返回:

cookie value, or null if the cookie does not exist.

allHeaders

List<Map.Entry<String,String>> allHeaders()

Returns all headers sent from client.

method

String method()

HTTP method (e.g. "GET" or "POST")

body

String body()

The body

bodyAsBytes

byte[] bodyAsBytes()

The body's byte array

data

HttpRequest data(String key,
               Object value)

从接口复制的说明: DataHolder

Store data value by key.

指定者:

data 在接口中 DataHolder

另请参阅:

DataHolder.data()

remoteAddress

SocketAddress remoteAddress()

Remote address of connection (i.e. the host of the client).

id

Object id()

A unique identifier for this request. This should be treated as an opaque object, that can be used to track the lifecycle of a request.

timestamp

long timestamp()

Timestamp (millis since epoch) of when this request was first received by the server.