org.springframework.test.web.reactive.server

Interface WebTestClient.RequestBodySpec

All Superinterfaces:

WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

All Known Subinterfaces:

WebTestClient.RequestBodyUriSpec

Enclosing interface:

WebTestClient

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

Specification for providing body of a request.

Method Summary

Modifier and Type	Method and Description
WebTestClient.RequestHeadersSpec<?>	body(org.springframework.web.reactive.function.BodyInserter<?,? super org.springframework.http.client.reactive.ClientHttpRequest> inserter) Set the body of the request to the given BodyInserter.
WebTestClient.RequestHeadersSpec<?>	body(Object body) Set the body of the request to the given Object and perform the request.
WebTestClient.RequestHeadersSpec<?>	body(Object producer, Class<?> elementClass) Set the body of the request to the given producer.
WebTestClient.RequestHeadersSpec<?>	body(Object producer, org.springframework.core.ParameterizedTypeReference<?> elementTypeRef) Set the body of the request to the given producer.
<T,S extends org.reactivestreams.Publisher<T>> WebTestClient.RequestHeadersSpec<?>	body(S publisher, Class<T> elementClass) Set the body of the request to the given asynchronous Publisher.
<T,S extends org.reactivestreams.Publisher<T>> WebTestClient.RequestHeadersSpec<?>	body(S publisher, org.springframework.core.ParameterizedTypeReference<T> elementTypeRef) Set the body of the request to the given asynchronous Publisher.
WebTestClient.RequestBodySpec	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
WebTestClient.RequestBodySpec	contentType(org.springframework.http.MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
WebTestClient.RequestHeadersSpec<?>	syncBody(Object body) Deprecated. as of Spring Framework 5.2 in favor of body(Object)

Methods inherited from interface org.springframework.test.web.reactive.server.WebTestClient.RequestHeadersSpec

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

Method Detail

contentLength

WebTestClient.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:

the same instance

See Also:

HttpHeaders.setContentLength(long)

contentType

WebTestClient.RequestBodySpec contentType(org.springframework.http.MediaType contentType)

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

Parameters:

contentType - the content type

Returns:

the same instance

See Also:

HttpHeaders.setContentType(MediaType)

body

WebTestClient.RequestHeadersSpec<?> body(Object body)

Set the body of the request to the given Object and perform the request.

This method is a convenient shortcut for:

 .body(BodyInserters.fromObject(object))
 

The body can be a MultiValueMap to create a multipart request. 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 conveniently using

Parameters:

body - the Object to write to the request

Returns:

spec for decoding the response

Since:

5.2

body

WebTestClient.RequestHeadersSpec<?> body(Object producer,
                                         Class<?> elementClass)

Set the body of the request to the given producer.

Parameters:

producer - the producer to write to the request. This must be a Publisher or another producer adaptable to a Publisher via ReactiveAdapterRegistry

elementClass - the class of elements contained in the producer

Returns:

spec for decoding the response

Since:

5.2

body

WebTestClient.RequestHeadersSpec<?> body(Object producer,
                                         org.springframework.core.ParameterizedTypeReference<?> elementTypeRef)

Set the body of the request to the given producer.

Parameters:

producer - the producer to write to the request. This must be a Publisher or another producer adaptable to a Publisher via ReactiveAdapterRegistry

elementTypeRef - the type reference of elements contained in the producer

Returns:

spec for decoding the response

Since:

5.2

body

<T,S extends org.reactivestreams.Publisher<T>> WebTestClient.RequestHeadersSpec<?> body(S publisher,
                                                                                        Class<T> elementClass)

Set the body of the request to the given asynchronous Publisher.

Type Parameters:

T - the type of the elements contained in the publisher

S - the type of the Publisher

Parameters:

publisher - the request body data

elementClass - the class of elements contained in the publisher

Returns:

spec for decoding the response

body

<T,S extends org.reactivestreams.Publisher<T>> WebTestClient.RequestHeadersSpec<?> body(S publisher,
                                                                                        org.springframework.core.ParameterizedTypeReference<T> elementTypeRef)

Set the body of the request to the given asynchronous Publisher.

Type Parameters:

T - the type of the elements contained in the publisher

S - the type of the Publisher

Parameters:

publisher - the request body data

elementTypeRef - the type reference of elements contained in the publisher

Returns:

spec for decoding the response

Since:

5.2

body

WebTestClient.RequestHeadersSpec<?> body(org.springframework.web.reactive.function.BodyInserter<?,? super org.springframework.http.client.reactive.ClientHttpRequest> inserter)

Set the body of the request to the given BodyInserter.

Parameters:

inserter - the inserter

Returns:

spec for decoding the response

See Also:

BodyInserters

syncBody

@Deprecated
WebTestClient.RequestHeadersSpec<?> syncBody(Object body)

Deprecated. as of Spring Framework 5.2 in favor of body(Object)

Set the body of the request to the given Object and perform the request.

This method is a convenient shortcut for:

 .body(BodyInserters.fromObject(object))
 

The body can be a MultiValueMap to create a multipart request. 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 conveniently using

Parameters:

body - the Object to write to the request

Returns:

spec for decoding the response

Throws:

IllegalArgumentException - if body is a Publisher or an instance of a type supported by ReactiveAdapterRegistry.getSharedInstance(), for which body(Publisher, Class) or body(Object, Class) should be used.