org.springframework.web.reactive.function.client

Class DefaultClientRequestBuilder

java.lang.Object

org.springframework.web.reactive.function.client.DefaultClientRequestBuilder

All Implemented Interfaces:

ClientRequest.Builder

final class DefaultClientRequestBuilder
extends java.lang.Object
implements ClientRequest.Builder

Default implementation of ClientRequest.Builder.

Since:

5.0

Author:

Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultClientRequestBuilder.BodyInserterRequest

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private BodyInserter<?,? super ClientHttpRequest>	body
private MultiValueMap<java.lang.String,java.lang.String>	cookies
private HttpHeaders	headers
private HttpMethod	method
private java.net.URI	url

Constructor Summary

Constructors

Constructor and Description
DefaultClientRequestBuilder(ClientRequest other)
DefaultClientRequestBuilder(HttpMethod method, java.net.URI url)

Method Summary

Modifier and Type	Method and Description
ClientRequest.Builder	attribute(java.lang.String name, java.lang.Object value) Set the attribute with the given name to the given value.
ClientRequest.Builder	attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.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 <any>> ClientRequest.Builder	body(P publisher, java.lang.Class<S> elementClass) Set the body of the request to the given Publisher and return it.
<S,P extends <any>> ClientRequest.Builder	body(P publisher, ParameterizedTypeReference<S> typeReference) Set the body of the request to the given Publisher and return it.
ClientRequest	build() Build the request.
ClientRequest.Builder	cookie(java.lang.String name, java.lang.String... values) Add a cookie with the given name and value(s).
ClientRequest.Builder	cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer) Manipulate this request's cookies with the given consumer.
ClientRequest.Builder	header(java.lang.String headerName, java.lang.String... headerValues) Add the given header value(s) under the given name.
ClientRequest.Builder	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate this request's headers with the given consumer.
ClientRequest.Builder	method(HttpMethod method) Set the method of the request.
ClientRequest.Builder	url(java.net.URI url) Set the url of the request.

Methods inherited from class java.lang.Object

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

Field Detail

method

private HttpMethod method

url

private java.net.URI url

headers

private final HttpHeaders headers

cookies

private final MultiValueMap<java.lang.String,java.lang.String> cookies

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

body

private BodyInserter<?,? super ClientHttpRequest> body

Constructor Detail

DefaultClientRequestBuilder

public DefaultClientRequestBuilder(ClientRequest other)

DefaultClientRequestBuilder

public DefaultClientRequestBuilder(HttpMethod method,
                                   java.net.URI url)

Method Detail

method

public ClientRequest.Builder method(HttpMethod method)

Description copied from interface: ClientRequest.Builder

Set the method of the request.

Specified by:

method in interface ClientRequest.Builder

Parameters:

method - the new method

Returns:

this builder

url

public ClientRequest.Builder url(java.net.URI url)

Description copied from interface: ClientRequest.Builder

Set the url of the request.

Specified by:

url in interface ClientRequest.Builder

Parameters:

url - the new url

Returns:

this builder

header

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

Description copied from interface: ClientRequest.Builder

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

Specified by:

header in interface ClientRequest.Builder

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

See Also:

HttpHeaders.add(String, String)

headers

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

Description copied from interface: 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.

Specified by:

headers in interface ClientRequest.Builder

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

cookie

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

Description copied from interface: ClientRequest.Builder

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

Specified by:

cookie in interface ClientRequest.Builder

Parameters:

name - the cookie name

values - the cookie value(s)

Returns:

this builder

cookies

public ClientRequest.Builder cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)

Description copied from interface: 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 header values, remove values, or use any of the other MultiValueMap methods.

Specified by:

cookies in interface ClientRequest.Builder

Parameters:

cookiesConsumer - a function that consumes the cookies map

Returns:

this builder

body

public <S,P extends <any>> ClientRequest.Builder body(P publisher,
                                                      java.lang.Class<S> elementClass)

Description copied from interface: ClientRequest.Builder

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

Specified by:

body in interface ClientRequest.Builder

Type Parameters:

S - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the Publisher to write to the request

elementClass - the class of elements contained in the publisher

Returns:

the built request

body

public <S,P extends <any>> ClientRequest.Builder body(P publisher,
                                                      ParameterizedTypeReference<S> typeReference)

Description copied from interface: ClientRequest.Builder

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

Specified by:

body in interface ClientRequest.Builder

Type Parameters:

S - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the Publisher to write to the request

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

Returns:

the built request

attribute

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

Description copied from interface: ClientRequest.Builder

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

Specified by:

attribute in interface ClientRequest.Builder

Parameters:

name - the name of the attribute to add

value - the value of the attribute to add

Returns:

this builder

attributes

public ClientRequest.Builder attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)

Description copied from interface: 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.

Specified by:

attributes in interface ClientRequest.Builder

Parameters:

attributesConsumer - a function that consumes the attributes

Returns:

this builder

body

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

Description copied from interface: ClientRequest.Builder

Set the body of the request to the given BodyInserter.

Specified by:

body in interface ClientRequest.Builder

Parameters:

inserter - the BodyInserter that writes to the request

Returns:

this builder

build

public ClientRequest build()

Description copied from interface: ClientRequest.Builder

Build the request.

Specified by:

build in interface ClientRequest.Builder