org.springframework.web.reactive.function.client

Interface WebClient.RequestBodySpec

All Superinterfaces:

WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

All Known Subinterfaces:

WebClient.RequestBodyUriSpec

Enclosing interface:

WebClient

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

Contract for specifying request headers and body leading up to the exchange.

Method Summary

Modifier and Type	Method and Description
WebClient.RequestHeadersSpec<?>	body(BodyInserter<?,? super ClientHttpRequest> inserter) Set the body of the request using the given body inserter.
<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?>	body(P publisher, java.lang.Class<T> elementClass) A shortcut for body(BodyInserter) with a Publisher inserter.
<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?>	body(P publisher, ParameterizedTypeReference<T> typeReference) A variant of body(Publisher, Class) that allows providing element type information that includes generics via a ParameterizedTypeReference.
WebClient.RequestBodySpec	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
WebClient.RequestBodySpec	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
WebClient.RequestHeadersSpec<?>	syncBody(java.lang.Object body) A shortcut for body(BodyInserter) with an Object inserter.

Methods inherited from interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec

accept, acceptCharset, attribute, attributes, cookie, cookies, exchange, header, headers, ifModifiedSince, ifNoneMatch, retrieve

Method Detail

contentLength

WebClient.RequestBodySpec contentLength(long contentLength)

Set the length of the body in bytes, as specified by the Content-Length header.

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

WebClient.RequestBodySpec contentType(MediaType contentType)

Set the media type of the body, as specified by the Content-Type header.

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

body

WebClient.RequestHeadersSpec<?> body(BodyInserter<?,? super ClientHttpRequest> inserter)

Set the body of the request using the given body inserter. BodyInserters provides access to built-in implementations of BodyInserter.

Parameters:

inserter - the body inserter to use for the request body

Returns:

this builder

See Also:

BodyInserters

body

<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?> body(P publisher,
                                                                                    java.lang.Class<T> elementClass)

A shortcut for body(BodyInserter) with a Publisher inserter. For example:

 Mono personMono = ... ;

 Mono result = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .body(personMono, Person.class)
     .retrieve()
     .bodyToMono(Void.class);
 

Type Parameters:

T - 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:

this builder

body

<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?> body(P publisher,
                                                                                    ParameterizedTypeReference<T> typeReference)

A variant of body(Publisher, Class) that allows providing element type information that includes generics via a ParameterizedTypeReference.

Type Parameters:

T - 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 - the type reference of elements contained in the publisher

Returns:

this builder

syncBody

WebClient.RequestHeadersSpec<?> syncBody(java.lang.Object body)

A shortcut for body(BodyInserter) with an Object inserter. For example:

 Person person = ... ;

 Mono<Void> result = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .syncBody(person)
     .retrieve()
     .bodyToMono(Void.class);
 

For multipart requests, provide a MultiValueMap. The values in the MultiValueMap can be any Object representing the body of the part, or an HttpEntity representing a part with body and headers. The MultiValueMap can be built with MultipartBodyBuilder.

Parameters:

body - the Object to write to the request

Returns:

this builder