org.springframework.test.web.reactive.server

Interface WebTestClient.HeaderSpec

All Known Implementing Classes:

DefaultWebTestClient.DefaultHeaderSpec

Enclosing interface:

WebTestClient

public static interface WebTestClient.HeaderSpec

Specification for adding request headers and performing an exchange.

Method Summary

Modifier and Type	Method and Description
WebTestClient.HeaderSpec	accept(MediaType... acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
WebTestClient.HeaderSpec	acceptCharset(java.nio.charset.Charset... acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
WebTestClient.HeaderSpec	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
WebTestClient.HeaderSpec	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
WebTestClient.HeaderSpec	cookie(java.lang.String name, java.lang.String value) Add a cookie with the given name and value.
WebTestClient.HeaderSpec	cookies(MultiValueMap<java.lang.String,java.lang.String> cookies) Copy the given cookies into the entity's cookies map.
WebTestClient.ResponseSpec	exchange() Perform the exchange without a request body.
<T> WebTestClient.ResponseSpec	exchange(BodyInserter<T,? super ClientHttpRequest> inserter) Perform the exchange with the body for the request populated using a BodyInserter.
<T,S extends <any>> WebTestClient.ResponseSpec	exchange(S publisher, java.lang.Class<T> elementClass) Perform the exchange and use the given Publisher for the request body.
WebTestClient.HeaderSpec	header(java.lang.String headerName, java.lang.String... headerValues) Add the given, single header value under the given name.
WebTestClient.HeaderSpec	headers(HttpHeaders headers) Copy the given headers into the entity's headers map.
WebTestClient.HeaderSpec	ifModifiedSince(java.time.ZonedDateTime ifModifiedSince) Set the value of the If-Modified-Since header.
WebTestClient.HeaderSpec	ifNoneMatch(java.lang.String... ifNoneMatches) Set the values of the If-None-Match header.

Method Detail

accept

WebTestClient.HeaderSpec accept(MediaType... acceptableMediaTypes)

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

Parameters:

acceptableMediaTypes - the acceptable media types

Returns:

the same instance

acceptCharset

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

the same instance

contentLength

WebTestClient.HeaderSpec 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.HeaderSpec contentType(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)

cookie

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

the same instance

cookies

WebTestClient.HeaderSpec cookies(MultiValueMap<java.lang.String,java.lang.String> cookies)

Copy the given cookies into the entity's cookies map.

Parameters:

cookies - the existing cookies to copy from

Returns:

the same instance

ifModifiedSince

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

the same instance

ifNoneMatch

WebTestClient.HeaderSpec ifNoneMatch(java.lang.String... ifNoneMatches)

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

Parameters:

ifNoneMatches - the new value of the header

Returns:

the same instance

header

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

the same instance

headers

WebTestClient.HeaderSpec headers(HttpHeaders headers)

Copy the given headers into the entity's headers map.

Parameters:

headers - the existing headers to copy from

Returns:

the same instance

exchange

WebTestClient.ResponseSpec exchange()

Perform the exchange without a request body.

Returns:

spec for decoding the response

exchange

<T> WebTestClient.ResponseSpec exchange(BodyInserter<T,? super ClientHttpRequest> inserter)

Perform the exchange with the body for the request populated using a BodyInserter.

Type Parameters:

T - the body type, or the the element type (for a stream)

Parameters:

inserter - the inserter

Returns:

spec for decoding the response

See Also:

BodyInserters

exchange

<T,S extends <any>> WebTestClient.ResponseSpec exchange(S publisher,
                                                        java.lang.Class<T> elementClass)

Perform the exchange and use the given Publisher for the request body.

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