程序包 cn.taketoday.web.reactive.function.client

类 DefaultClientRequestBuilder

java.lang.Object

cn.taketoday.web.reactive.function.client.DefaultClientRequestBuilder

所有已实现的接口:

ClientRequest.Builder

final class DefaultClientRequestBuilder
extends Object
implements ClientRequest.Builder

Default implementation of ClientRequest.Builder.

从以下版本开始:

4.0

作者:

Arjen Poutsma

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	DefaultClientRequestBuilder.BodyInserterRequest

字段概要

字段

修饰符和类型	字段	说明
private final Map<String,Object>	attributes
private BodyInserter<?,? super ClientHttpRequest>	body
private final cn.taketoday.util.MultiValueMap<String,String>	cookies
private final HttpHeaders	headers
private Consumer<ClientHttpRequest>	httpRequestConsumer
private HttpMethod	method
private URI	url

构造器概要

构造器

构造器	说明
DefaultClientRequestBuilder(HttpMethod method, URI url)
DefaultClientRequestBuilder(ClientRequest other)

方法概要

修饰符和类型	方法	说明
ClientRequest.Builder	attribute(String name, Object value)	Set the attribute with the given name to the given value.
ClientRequest.Builder	attributes(Consumer<Map<String,Object>> attributesConsumer)	Manipulate the request attributes with the given consumer.
ClientRequest.Builder	body(BodyInserter<?,? super ClientHttpRequest> inserter)	Set the body of the request to the given BodyInserter.
<S, P extends org.reactivestreams.Publisher<S>> ClientRequest.Builder	body(P publisher, cn.taketoday.core.ParameterizedTypeReference<S> typeReference)	Set the body of the request to the given Publisher and return it.
<S, P extends org.reactivestreams.Publisher<S>> ClientRequest.Builder	body(P publisher, Class<S> elementClass)	Set the body of the request to the given Publisher and return it.
ClientRequest	build()	Build the request.
ClientRequest.Builder	cookie(String name, String... values)	Add a cookie with the given name and value(s).
ClientRequest.Builder	cookies(Consumer<cn.taketoday.util.MultiValueMap<String,String>> cookiesConsumer)	Manipulate this request's cookies with the given consumer.
ClientRequest.Builder	header(String headerName, String... headerValues)	Add the given header value(s) under the given name.
ClientRequest.Builder	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this request's headers with the given consumer.
ClientRequest.Builder	httpRequest(Consumer<ClientHttpRequest> requestConsumer)	Callback for access to the ClientHttpRequest that in turn provides access to the native request of the underlying HTTP library.
ClientRequest.Builder	method(HttpMethod method)	Set the method of the request.
ClientRequest.Builder	url(URI url)	Set the url of the request.

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

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

字段详细资料

method

private HttpMethod method

url

private URI url

headers

private final HttpHeaders headers

cookies

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

attributes

private final Map<String,Object> attributes

body

private BodyInserter<?,? super ClientHttpRequest> body

httpRequestConsumer

@Nullable
private Consumer<ClientHttpRequest> httpRequestConsumer

构造器详细资料

DefaultClientRequestBuilder

public DefaultClientRequestBuilder(ClientRequest other)

DefaultClientRequestBuilder

public DefaultClientRequestBuilder(HttpMethod method,
 URI url)

方法详细资料

method

public ClientRequest.Builder method(HttpMethod method)

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

Set the method of the request.

指定者:

method 在接口中 ClientRequest.Builder

参数:

method - the new method

返回:

this builder

url

public ClientRequest.Builder url(URI url)

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

Set the url of the request.

指定者:

url 在接口中 ClientRequest.Builder

参数:

url - the new url

返回:

this builder

header

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

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

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

指定者:

header 在接口中 ClientRequest.Builder

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

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

从接口复制的说明: ClientRequest.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 在接口中 ClientRequest.Builder

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

cookie

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

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

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

指定者:

cookie 在接口中 ClientRequest.Builder

参数:

name - the cookie name

values - the cookie value(s)

返回:

this builder

cookies

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

从接口复制的说明: ClientRequest.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 cookie values, remove cookies, or use any of the other MultiValueMap methods.

指定者:

cookies 在接口中 ClientRequest.Builder

参数:

cookiesConsumer - a function that consumes the cookies map

返回:

this builder

body

public <S,
P extends org.reactivestreams.Publisher<S>>
ClientRequest.Builder body(P publisher,
 Class<S> elementClass)

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

Set the body of the request to the given Publisher and return it.

指定者:

body 在接口中 ClientRequest.Builder

类型参数:

S - the type of the elements contained in the publisher

P - the type of the Publisher

参数:

publisher - the Publisher to write to the request

elementClass - the class of elements contained in the publisher

返回:

the built request

body

public <S,
P extends org.reactivestreams.Publisher<S>>
ClientRequest.Builder body(P publisher,
 cn.taketoday.core.ParameterizedTypeReference<S> typeReference)

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

Set the body of the request to the given Publisher and return it.

指定者:

body 在接口中 ClientRequest.Builder

类型参数:

S - the type of the elements contained in the publisher

P - the type of the Publisher

参数:

publisher - the Publisher to write to the request

typeReference - a type reference describing the elements contained in the publisher

返回:

the built request

attribute

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

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

Set the attribute with the given name to the given value.

指定者:

attribute 在接口中 ClientRequest.Builder

参数:

name - the name of the attribute to add

value - the value of the attribute to add

返回:

this builder

attributes

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

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

Manipulate the request attributes with the given consumer. The attributes provided to the consumer are "live", so that the consumer can be used to inspect attributes, remove attributes, or use any of the other map-provided methods.

指定者:

attributes 在接口中 ClientRequest.Builder

参数:

attributesConsumer - a function that consumes the attributes

返回:

this builder

httpRequest

public ClientRequest.Builder httpRequest(Consumer<ClientHttpRequest> requestConsumer)

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

Callback for access to the ClientHttpRequest that in turn provides access to the native request of the underlying HTTP library. This could be useful for setting advanced, per-request options that exposed by the underlying library.

指定者:

httpRequest 在接口中 ClientRequest.Builder

参数:

requestConsumer - a consumer to access the ClientHttpRequest with

返回:

this builder

body

public ClientRequest.Builder body(BodyInserter<?,? super ClientHttpRequest> inserter)

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

Set the body of the request to the given BodyInserter.

指定者:

body 在接口中 ClientRequest.Builder

参数:

inserter - the BodyInserter that writes to the request

返回:

this builder

build

public ClientRequest build()

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

Build the request.

指定者:

build 在接口中 ClientRequest.Builder