org.springframework.test.web.reactive.server

Interface WebTestClient.Builder

Enclosing interface:

WebTestClient

public static interface WebTestClient.Builder

Steps for customizing the WebClient used to test with internally delegating to a WebClient.Builder.

Method Summary

Modifier and Type	Method and Description
WebTestClient.Builder	baseUrl(String baseUrl) Configure a base URI as described in WebClient.create(String).
WebTestClient	build() Build the WebTestClient instance.
WebTestClient.Builder	defaultCookie(String cookieName, String... cookieValues) Add the given header to all requests that haven't added it.
WebTestClient.Builder	defaultHeader(String headerName, String... headerValues) Add the given header to all requests that haven't added it.
WebTestClient.Builder	exchangeStrategies(org.springframework.web.reactive.function.client.ExchangeStrategies strategies) Configure the ExchangeStrategies to use.
WebTestClient.Builder	responseTimeout(Duration timeout) Max amount of time to wait for responses.
WebTestClient.Builder	uriBuilderFactory(org.springframework.web.util.UriBuilderFactory uriBuilderFactory) Provide a pre-configured UriBuilderFactory instance as an alternative to and effectively overriding baseUrl(String).

Method Detail

baseUrl

WebTestClient.Builder baseUrl(String baseUrl)

Configure a base URI as described in WebClient.create(String).

uriBuilderFactory

WebTestClient.Builder uriBuilderFactory(org.springframework.web.util.UriBuilderFactory uriBuilderFactory)

Provide a pre-configured UriBuilderFactory instance as an alternative to and effectively overriding baseUrl(String).

defaultHeader

WebTestClient.Builder defaultHeader(String headerName,
                                    String... headerValues)

Add the given header to all requests that haven't added it.

Parameters:

headerName - the header name

headerValues - the header values

defaultCookie

WebTestClient.Builder defaultCookie(String cookieName,
                                    String... cookieValues)

Add the given header to all requests that haven't added it.

Parameters:

cookieName - the cookie name

cookieValues - the cookie values

exchangeStrategies

WebTestClient.Builder exchangeStrategies(org.springframework.web.reactive.function.client.ExchangeStrategies strategies)

Configure the ExchangeStrategies to use.

By default ExchangeStrategies.withDefaults() is used.

Parameters:

strategies - the strategies to use

responseTimeout

WebTestClient.Builder responseTimeout(Duration timeout)

Max amount of time to wait for responses.

By default 5 seconds.

Parameters:

timeout - the response timeout value

build

WebTestClient build()

Build the WebTestClient instance.