org.springframework.web.reactive.function.client

Interface WebClient.Builder

All Known Implementing Classes:

DefaultWebClientBuilder

Enclosing interface:

WebClient

public static interface WebClient.Builder

A mutable builder for a WebClient.

Method Summary

Modifier and Type	Method and Description
WebClient.Builder	baseUrl(java.lang.String baseUrl) Configure a base URI as described in WebClient.create(String).
WebClient	build() Builder the WebClient instance.
WebClient.Builder	clientConnector(ClientHttpConnector connector) Configure the ClientHttpConnector to use.
WebClient.Builder	defaultCookie(java.lang.String cookieName, java.lang.String... cookieValues) Add the given header to all requests that haven't added it.
WebClient.Builder	defaultHeader(java.lang.String headerName, java.lang.String... headerValues) Add the given header to all requests that haven't added it.
WebClient.Builder	defaultUriVariables(java.util.Map<java.lang.String,?> defaultUriVariables) Configure default URI variable values that will be used when expanding URI templates using a Map.
WebClient.Builder	exchangeFunction(ExchangeFunction exchangeFunction) Provide a pre-configured ExchangeFunction instance.
WebClient.Builder	exchangeStrategies(ExchangeStrategies strategies) Configure the ExchangeStrategies to use.
WebClient.Builder	uriBuilderFactory(UriBuilderFactory uriBuilderFactory) Provide a pre-configured UriBuilderFactory instance.

Method Detail

baseUrl

WebClient.Builder baseUrl(java.lang.String baseUrl)

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

See Also:

defaultUriVariables(Map), uriBuilderFactory(UriBuilderFactory)

defaultUriVariables

WebClient.Builder defaultUriVariables(java.util.Map<java.lang.String,?> defaultUriVariables)

Configure default URI variable values that will be used when expanding URI templates using a Map.

Parameters:

defaultUriVariables - the default values to use

See Also:

baseUrl(String), uriBuilderFactory(UriBuilderFactory)

uriBuilderFactory

WebClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

Provide a pre-configured UriBuilderFactory instance. This is an alternative to and effectively overrides the following:

• baseUrl(String)
• defaultUriVariables(Map).

Parameters:

uriBuilderFactory - the URI builder factory to use

See Also:

baseUrl(String), defaultUriVariables(Map)

defaultHeader

WebClient.Builder defaultHeader(java.lang.String headerName,
                                java.lang.String... headerValues)

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

Parameters:

headerName - the header name

headerValues - the header values

defaultCookie

WebClient.Builder defaultCookie(java.lang.String cookieName,
                                java.lang.String... cookieValues)

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

Parameters:

cookieName - the cookie name

cookieValues - the cookie values

clientConnector

WebClient.Builder clientConnector(ClientHttpConnector connector)

Configure the ClientHttpConnector to use.

By default an instance of ReactorClientHttpConnector is created if this is not set. However a shared instance may be passed instead, e.g. for use with multiple WebClient's targeting different base URIs.

Parameters:

connector - the connector to use

See Also:

exchangeStrategies(ExchangeStrategies), exchangeFunction(ExchangeFunction)

exchangeStrategies

WebClient.Builder exchangeStrategies(ExchangeStrategies strategies)

Configure the ExchangeStrategies to use.

By default ExchangeStrategies.withDefaults() is used.

Parameters:

strategies - the strategies to use

See Also:

clientConnector(ClientHttpConnector), exchangeFunction(ExchangeFunction)

exchangeFunction

WebClient.Builder exchangeFunction(ExchangeFunction exchangeFunction)

Provide a pre-configured ExchangeFunction instance. This is an alternative to and effectively overrides the following:

• clientConnector(ClientHttpConnector)
• exchangeStrategies(ExchangeStrategies).

Parameters:

exchangeFunction - the exchange function to use

See Also:

clientConnector(ClientHttpConnector), exchangeStrategies(ExchangeStrategies)

build

WebClient build()

Builder the WebClient instance.