org.springframework.web.reactive.function.client

Interface WebClient.RequestHeadersSpec<S extends WebClient.RequestHeadersSpec<S>>

All Known Subinterfaces:

WebClient.RequestBodySpec, WebClient.RequestBodyUriSpec, WebClient.RequestHeadersUriSpec<S>

Enclosing interface:

WebClient

public static interface WebClient.RequestHeadersSpec<S extends WebClient.RequestHeadersSpec<S>>

Contract for specifying request headers leading up to the exchange.

Method Summary

Modifier and Type	Method and Description
S	accept(MediaType... acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
S	acceptCharset(java.nio.charset.Charset... acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
S	attribute(java.lang.String name, java.lang.Object value) Set the attribute with the given name to the given value.
S	attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer) Manipulate the request attributes with the given consumer.
S	cookie(java.lang.String name, java.lang.String value) Add a cookie with the given name and value.
S	cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer) Manipulate the request's cookies with the given consumer.
reactor.core.publisher.Mono<ClientResponse>	exchange() Perform the HTTP request and return a ClientResponse with the response status and headers.
S	header(java.lang.String headerName, java.lang.String... headerValues) Add the given, single header value under the given name.
S	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate the request's headers with the given consumer.
S	ifModifiedSince(java.time.ZonedDateTime ifModifiedSince) Set the value of the If-Modified-Since header.
S	ifNoneMatch(java.lang.String... ifNoneMatches) Set the values of the If-None-Match header.
WebClient.ResponseSpec	retrieve() Perform the HTTP request and retrieve the response body:

Method Detail

accept

S accept(MediaType... acceptableMediaTypes)

Set the list of acceptable media types, as specified by the Accept header.

Parameters:

acceptableMediaTypes - the acceptable media types

Returns:

this builder

acceptCharset

S acceptCharset(java.nio.charset.Charset... acceptableCharsets)

Set the list of acceptable charsets, as specified by the Accept-Charset header.

Parameters:

acceptableCharsets - the acceptable charsets

Returns:

this builder

cookie

S cookie(java.lang.String name,
         java.lang.String value)

Add a cookie with the given name and value.

Parameters:

name - the cookie name

value - the cookie value

Returns:

this builder

cookies

S cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)

Manipulate the 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.

Parameters:

cookiesConsumer - a function that consumes the cookies map

Returns:

this builder

ifModifiedSince

S ifModifiedSince(java.time.ZonedDateTime ifModifiedSince)

Set the value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

Parameters:

ifModifiedSince - the new value of the header

Returns:

this builder

ifNoneMatch

S ifNoneMatch(java.lang.String... ifNoneMatches)

Set the values of the If-None-Match header.

Parameters:

ifNoneMatches - the new value of the header

Returns:

this builder

header

S header(java.lang.String headerName,
         java.lang.String... headerValues)

Add the given, single header value under the given name.

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

headers

S headers(java.util.function.Consumer<HttpHeaders> headersConsumer)

Manipulate the 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.

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

attribute

S attribute(java.lang.String name,
            java.lang.Object value)

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

Parameters:

name - the name of the attribute to add

value - the value of the attribute to add

Returns:

this builder

attributes

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

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.

Parameters:

attributesConsumer - a function that consumes the attributes

Returns:

this builder

retrieve

WebClient.ResponseSpec retrieve()

Perform the HTTP request and retrieve the response body:

 Mono<Person> bodyMono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .retrieve()
     .bodyToMono(Person.class);
 

This method is a shortcut to using exchange() and decoding the response body through ClientResponse.

Returns:

ResponseSpec to specify how to decode the body

See Also:

exchange()

exchange

reactor.core.publisher.Mono<ClientResponse> exchange()

Perform the HTTP request and return a ClientResponse with the response status and headers. You can then use methods of the response to consume the body:

 Mono<Person> mono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .exchange()
     .flatMap(response -> response.bodyToMono(Person.class));

 Flux<Person> flux = client.get()
     .uri("/persons")
     .accept(MediaType.APPLICATION_STREAM_JSON)
     .exchange()
     .flatMapMany(response -> response.bodyToFlux(Person.class));
 

NOTE: You must always use of the body or entity methods on ClientResponse to ensure resources are released and avoid potential issues with HTTP connection pooling. If not interested in the response body, use "bodyToMono(Void.class)" to complete.

Returns:

a Mono for the response

See Also:

retrieve()