程序包 cn.taketoday.web.handler.function

类 DefaultServerRequestBuilder

java.lang.Object

cn.taketoday.web.handler.function.DefaultServerRequestBuilder

所有已实现的接口:

ServerRequest.Builder

class DefaultServerRequestBuilder
extends Object
implements ServerRequest.Builder

Default ServerRequest.Builder implementation.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	DefaultServerRequestBuilder.BodyInputStream
private static class	DefaultServerRequestBuilder.BuiltServerRequest

字段概要

字段

修饰符和类型	字段	说明
private final Map<String,Object>	attributes
private byte[]	body
private final cn.taketoday.util.MultiValueMap<String,HttpCookie>	cookies
private final HttpHeaders	headers
private final List<HttpMessageConverter<?>>	messageConverters
private HttpMethod	method
private final cn.taketoday.util.MultiValueMap<String,String>	params
private InetSocketAddress	remoteAddress
private final RequestContext	requestContext
private URI	uri

构造器概要

构造器

构造器	说明
DefaultServerRequestBuilder(ServerRequest other)

方法概要

修饰符和类型	方法	说明
ServerRequest.Builder	attribute(String name, Object value)	Add an attribute with the given name and value.
ServerRequest.Builder	attributes(Consumer<Map<String,Object>> attributesConsumer)	Manipulate this request's attributes with the given consumer.
ServerRequest.Builder	body(byte[] body)	Set the body of the request.
ServerRequest.Builder	body(String body)	Set the body of the request to the UTF-8 encoded bytes of the given string.
ServerRequest	build()	Build the request.
ServerRequest.Builder	cookie(String name, String... values)	Add a cookie with the given name and value(s).
ServerRequest.Builder	cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)	Manipulate this request's cookies with the given consumer.
ServerRequest.Builder	header(String headerName, String... headerValues)	Add the given header value(s) under the given name.
ServerRequest.Builder	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this request's headers with the given consumer.
ServerRequest.Builder	method(HttpMethod method)	Set the method of the request.
ServerRequest.Builder	param(String name, String... values)	Add a parameter with the given name and value.
ServerRequest.Builder	params(Consumer<cn.taketoday.util.MultiValueMap<String,String>> paramsConsumer)	Manipulate this request's parameters with the given consumer.
ServerRequest.Builder	remoteAddress(InetSocketAddress remoteAddress)	Set the remote address of the request.
ServerRequest.Builder	uri(URI uri)	Set the URI of the request.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

requestContext

private final RequestContext requestContext

messageConverters

private final List<HttpMessageConverter<?>> messageConverters

method

private HttpMethod method

uri

private URI uri

headers

private final HttpHeaders headers

cookies

private final cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies

attributes

private final Map<String,Object> attributes

params

private final cn.taketoday.util.MultiValueMap<String,String> params

remoteAddress

@Nullable
private InetSocketAddress remoteAddress

body

private byte[] body

构造器详细资料

DefaultServerRequestBuilder

public DefaultServerRequestBuilder(ServerRequest other)

方法详细资料

method

public ServerRequest.Builder method(HttpMethod method)

从接口复制的说明: ServerRequest.Builder

Set the method of the request.

指定者:

method 在接口中 ServerRequest.Builder

参数:

method - the new method

返回:

this builder

uri

public ServerRequest.Builder uri(URI uri)

从接口复制的说明: ServerRequest.Builder

Set the URI of the request.

指定者:

uri 在接口中 ServerRequest.Builder

参数:

uri - the new URI

返回:

this builder

header

public ServerRequest.Builder header(String headerName,
 String... headerValues)

从接口复制的说明: ServerRequest.Builder

Add the given header value(s) under the given name.

指定者:

header 在接口中 ServerRequest.Builder

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public ServerRequest.Builder headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: ServerRequest.Builder

Manipulate this request's headers with the given consumer.

The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

指定者:

headers 在接口中 ServerRequest.Builder

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

cookie

public ServerRequest.Builder cookie(String name,
 String... values)

从接口复制的说明: ServerRequest.Builder

Add a cookie with the given name and value(s).

指定者:

cookie 在接口中 ServerRequest.Builder

参数:

name - the cookie name

values - the cookie value(s)

返回:

this builder

cookies

public ServerRequest.Builder cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)

从接口复制的说明: ServerRequest.Builder

Manipulate this request's cookies with the given consumer.

The map provided to the consumer is "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

指定者:

cookies 在接口中 ServerRequest.Builder

参数:

cookiesConsumer - a function that consumes the cookies map

返回:

this builder

body

public ServerRequest.Builder body(byte[] body)

从接口复制的说明: ServerRequest.Builder

Set the body of the request.

Calling this methods will release the existing body of the builder.

指定者:

body 在接口中 ServerRequest.Builder

参数:

body - the new body

返回:

this builder

body

public ServerRequest.Builder body(String body)

从接口复制的说明: ServerRequest.Builder

Set the body of the request to the UTF-8 encoded bytes of the given string.

Calling this methods will release the existing body of the builder.

指定者:

body 在接口中 ServerRequest.Builder

参数:

body - the new body

返回:

this builder

attribute

public ServerRequest.Builder attribute(String name,
 Object value)

从接口复制的说明: ServerRequest.Builder

Add an attribute with the given name and value.

指定者:

attribute 在接口中 ServerRequest.Builder

参数:

name - the attribute name

value - the attribute value

返回:

this builder

attributes

public ServerRequest.Builder attributes(Consumer<Map<String,Object>> attributesConsumer)

从接口复制的说明: ServerRequest.Builder

Manipulate this request's attributes with the given consumer.

The map provided to the consumer is "live", so that the consumer can be used to overwrite existing attributes, remove attributes, or use any of the other Map methods.

指定者:

attributes 在接口中 ServerRequest.Builder

参数:

attributesConsumer - a function that consumes the attributes map

返回:

this builder

param

public ServerRequest.Builder param(String name,
 String... values)

从接口复制的说明: ServerRequest.Builder

Add a parameter with the given name and value.

指定者:

param 在接口中 ServerRequest.Builder

参数:

name - the parameter name

values - the parameter value(s)

返回:

this builder

params

public ServerRequest.Builder params(Consumer<cn.taketoday.util.MultiValueMap<String,String>> paramsConsumer)

从接口复制的说明: ServerRequest.Builder

Manipulate this request's parameters with the given consumer.

The map provided to the consumer is "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

指定者:

params 在接口中 ServerRequest.Builder

参数:

paramsConsumer - a function that consumes the parameters map

返回:

this builder

remoteAddress

public ServerRequest.Builder remoteAddress(InetSocketAddress remoteAddress)

从接口复制的说明: ServerRequest.Builder

Set the remote address of the request.

指定者:

remoteAddress 在接口中 ServerRequest.Builder

参数:

remoteAddress - the remote address

返回:

this builder

build

public ServerRequest build()

从接口复制的说明: ServerRequest.Builder

Build the request.

指定者:

build 在接口中 ServerRequest.Builder

返回:

the built request