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 the body of a request.

since:

5.0

Author:

Rossen stoyanchev, Brian Clozel, sam Brannen, Michał Rowicki

Method summary

Modifier and Type	Method	Description
WebTestClient.RequestHeadersspec<?>	body(Object&nbsp;producer, Class<?>&nbsp;elementClass)	set the body from the given producer.
WebTestClient.RequestHeadersspec<?>	body(Object&nbsp;producer, ParameterizedTypeReference<?>&nbsp;elementTypeRef)	set the body from the given producer.
WebTestClient.RequestHeadersspec<?>	body(BodyInserter<?, ? super ClientHttpRequest>&nbsp;inserter)	set the body of the request to the given BodyInserter.
<T, s extends Publisher<T>> WebTestClient.RequestHeadersspec<?>	body(s&nbsp;publisher, Class<T>&nbsp;elementClass)	set the body from the given Publisher.
<T, s extends Publisher<T>> WebTestClient.RequestHeadersspec<?>	body(s&nbsp;publisher, ParameterizedTypeReference<T>&nbsp;elementTypeRef)	Variant of body(Publisher, Class) that allows providing element type information with generics.
WebTestClient.RequestHeadersspec<?>	bodyValue(Object&nbsp;body)	set the body to the given Object value.
WebTestClient.RequestBodyspec	contentLength(long&nbsp;contentLength)	set the length of the body in bytes, as specified by the Content-Length header.
WebTestClient.RequestBodyspec	contentType(MediaType&nbsp;contentType)	set the media type of the body, as specified by the Content-Type header.

Methods inherited from interface WebTestClient.RequestHeadersspec

accept, acceptCharset, apiVersion, attribute, attributes, cookie, cookies, exchange, exchangesuccessfully, header, headers, ifModifiedsince, ifNoneMatch

Method Details

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:

this spec for further declaration of the request

see Also:

• HttpHeaders.setContentLength(long)

contentType

WebTestClient.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 spec for further declaration of the request

see Also:

• HttpHeaders.setContentType(MediaType)

bodyValue

WebTestClient.RequestHeadersspec<?>&nbsp;bodyValue(Object&nbsp;body)

set the body to the given Object value. This method invokes the bodyValue method on the underlying WebClient.

Parameters:

body - the value to write to the request body

Returns:

this spec for further declaration of the request

since:

5.2

body

<T, s extends Publisher<T>>
WebTestClient.RequestHeadersspec<?>&nbsp;body(s&nbsp;publisher,
 Class<T>&nbsp;elementClass)

set the body from the given Publisher. shortcut for body(BodyInserter) with a Publisher inserter.

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:

this spec for further declaration of the request

body

<T, s extends Publisher<T>>
WebTestClient.RequestHeadersspec<?>&nbsp;body(s&nbsp;publisher,
 ParameterizedTypeReference<T>&nbsp;elementTypeRef)

Variant of body(Publisher, Class) that allows providing element type information with generics.

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:

this spec for further declaration of the request

since:

5.2

body

WebTestClient.RequestHeadersspec<?>&nbsp;body(Object&nbsp;producer,
 Class<?>&nbsp;elementClass)

set the body from the given producer. This method invokes the body(Object, Class) method on the underlying WebClient.

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:

this spec for further declaration of the request

since:

5.2

body

WebTestClient.RequestHeadersspec<?>&nbsp;body(Object&nbsp;producer,
 ParameterizedTypeReference<?>&nbsp;elementTypeRef)

set the body from the given producer. This method invokes the body(Object, ParameterizedTypeReference) method on the underlying WebClient.

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:

this spec for further declaration of the request

since:

5.2

body

WebTestClient.RequestHeadersspec<?>&nbsp;body(BodyInserter<?, ? super ClientHttpRequest>&nbsp;inserter)

set the body of the request to the given BodyInserter.

This method invokes the body(BodyInserter) method on the underlying WebClient.

Parameters:

inserter - the body inserter to use

Returns:

this spec for further declaration of the request

see Also:

• BodyInserters