Interface WebTestClient.Builder

Method Detail

• baseUrl

  WebTestClient.Builder baseUrl​(String baseUrl)

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

• uriBuilderFactory

  WebTestClient.Builder uriBuilderFactory​(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

• defaultHeaders

  WebTestClient.Builder defaultHeaders​(Consumer<HttpHeaders> headersConsumer)

  Manipulate the default headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

  Parameters:

  headersConsumer - a function that consumes the HttpHeaders

  Returns:

  this builder

• 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

• defaultCookies

  WebTestClient.Builder defaultCookies​(Consumer<MultiValueMap<String,​String>> cookiesConsumer)

  Manipulate the default cookies with the given consumer. The map provided to the consumer is "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other MultiValueMap methods.

  Parameters:

  cookiesConsumer - a function that consumes the cookies map

  Returns:

  this builder

• filter

  WebTestClient.Builder filter​(ExchangeFilterFunction filter)

  Add the given filter to the filter chain.

  Parameters:

  filter - the filter to be added to the chain

• filters

  WebTestClient.Builder filters​(Consumer<List<ExchangeFilterFunction>> filtersConsumer)

  Manipulate the filters with the given consumer. The list provided to the consumer is "live", so that the consumer can be used to remove filters, change ordering, etc.

  Parameters:

  filtersConsumer - a function that consumes the filter list

  Returns:

  this builder

• codecs

  WebTestClient.Builder codecs​(Consumer<ClientCodecConfigurer> configurer)

  Configure the codecs for the WebClient in the underlyingExchangeStrategies.

  Parameters:

  configurer - the configurer to apply

  Since:

  5.1.13

• exchangeStrategies

  WebTestClient.Builder exchangeStrategies​(ExchangeStrategies strategies)

  Configure the ExchangeStrategies to use.

  For most cases, prefer using codecs(Consumer) which allows customizing the codecs in the ExchangeStrategies rather than replace them. That ensures multiple parties can contribute to codecs configuration.

  By default this is set to ExchangeStrategies.withDefaults().

  Parameters:

  strategies - the strategies to use

• exchangeStrategies

  @Deprecated
  WebTestClient.Builder exchangeStrategies​(Consumer<ExchangeStrategies.Builder> configurer)

  Deprecated.

  as of 5.1.13 in favor of codecs(Consumer)
  Customize the strategies configured via exchangeStrategies(ExchangeStrategies). This method is designed for use in scenarios where multiple parties wish to update the ExchangeStrategies.

• responseTimeout

  WebTestClient.Builder responseTimeout​(Duration timeout)

  Max amount of time to wait for responses.

  By default 5 seconds.

  Parameters:

  timeout - the response timeout value

• apply

  WebTestClient.Builder apply​(WebTestClientConfigurer configurer)

  Apply the given configurer to this builder instance.

  This can be useful for applying pre-packaged customizations.

  Parameters:

  configurer - the configurer to apply

• build

  WebTestClient build()

  Build the WebTestClient instance.