java.lang.Object
io.helidon.webclient.WebClient.Builder
- All Implemented Interfaces:
io.helidon.common.Builder<WebClient.Builder,,WebClient> MediaContextBuilder<WebClient.Builder>,ParentingMediaContextBuilder<WebClient.Builder>,Supplier<WebClient>
- Enclosing interface:
- WebClient
public static final class WebClient.Builder
extends Object
implements io.helidon.common.Builder<WebClient.Builder,WebClient>, ParentingMediaContextBuilder<WebClient.Builder>, MediaContextBuilder<WebClient.Builder>
Fluent API builder for
WebClient.-
Method Summary
Modifier and TypeMethodDescriptionAdd a default cookie.Add a default header (such as accept).addMediaSupport(MediaSupport mediaSupport) addReader(MessageBodyReader<?> reader) addService(WebClientService service) Register new instance ofWebClientService.addService(Supplier<? extends WebClientService> serviceSupplier) Register new instance ofWebClientService.addStreamReader(MessageBodyStreamReader<?> streamReader) addStreamWriter(MessageBodyStreamWriter<?> streamWriter) addWriter(MessageBodyWriter<?> writer) Sets base uri for each request.Sets base uri for each request.Sets base url for each request.build()Config of this client.connectTimeout(long amount, TimeUnit unit) Sets new connection timeout.Sets specific context which should be used in requests.followRedirects(boolean follow) Sets if redirects should be followed or not.keepAlive(boolean keepAlive) Set whether connection to server should be kept alive after request.mediaContext(MediaContext mediaContext) Sets new proxy which will used for the requests.readTimeout(long amount, TimeUnit unit) Sets new read timeout.tls(WebClientTls webClientTls) Sets newWebClientTlsinstance which contains ssl configuration.Sets user agent name.useSystemServiceLoader(boolean useServiceLoader) Sets if Java Service loader should be used to load allWebClientServiceProvider.validateHeaders(boolean validate) Whether to validate header names.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.helidon.common.Builder
get, identity, update
-
Method Details
-
build
- Specified by:
buildin interfaceio.helidon.common.Builder<WebClient.Builder,WebClient>
-
addService
Register new instance ofWebClientService.- Parameters:
service- client service instance- Returns:
- updated builder instance
-
addService
Register new instance ofWebClientService.- Parameters:
serviceSupplier- client service instance- Returns:
- updated builder instance
-
useSystemServiceLoader
Sets if Java Service loader should be used to load allWebClientServiceProvider.- Parameters:
useServiceLoader- whether to use the Java Service loader- Returns:
- updated builder instance
-
proxy
Sets new proxy which will used for the requests.- Parameters:
proxy- proxy instance- Returns:
- updated builder instance
-
mediaContext
- Specified by:
mediaContextin interfaceParentingMediaContextBuilder<WebClient.Builder>
-
addMediaSupport
- Specified by:
addMediaSupportin interfaceMediaContextBuilder<WebClient.Builder>
-
addReader
- Specified by:
addReaderin interfaceMediaContextBuilder<WebClient.Builder>
-
addStreamReader
- Specified by:
addStreamReaderin interfaceMediaContextBuilder<WebClient.Builder>
-
addWriter
- Specified by:
addWriterin interfaceMediaContextBuilder<WebClient.Builder>
-
addStreamWriter
- Specified by:
addStreamWriterin interfaceMediaContextBuilder<WebClient.Builder>
-
config
Config of this client.- Parameters:
config- client config- Returns:
- updated builder instance
-
connectTimeout
Sets new connection timeout.- Parameters:
amount- amount of timeunit- time unit- Returns:
- updated builder instance
-
readTimeout
Sets new read timeout.- Parameters:
amount- amount of timeunit- time unit- Returns:
- updated builder instance
-
tls
Sets newWebClientTlsinstance which contains ssl configuration.- Parameters:
webClientTls- tls instance- Returns:
- updated builder instance
-
context
Sets specific context which should be used in requests.- Parameters:
context- context- Returns:
- updated builder instance
-
addCookie
Add a default cookie.- Parameters:
name- cookie namevalue- cookie value- Returns:
- updated builder instance
-
addHeader
Add a default header (such as accept).- Parameters:
header- header namevalue- header values- Returns:
- updated builder instance
-
baseUri
Sets base uri for each request.- Parameters:
uri- base uri- Returns:
- updated builder instance
-
baseUri
Sets base uri for each request.- Parameters:
uri- base uri- Returns:
- updated builder instance
-
baseUri
Sets base url for each request.- Parameters:
url- base url- Returns:
- updated builder instance
-
followRedirects
Sets if redirects should be followed or not.- Parameters:
follow- follow redirects- Returns:
- updated builder instance
-
userAgent
Sets user agent name.- Parameters:
userAgent- user agent- Returns:
- updated builder instance
-
keepAlive
Set whether connection to server should be kept alive after request. This also sets headerHttp.Header.CONNECTIONtokeep-alive.- Parameters:
keepAlive- keep connection alive- Returns:
- updated builder instance
-
validateHeaders
Whether to validate header names. Defaults totrue.- Parameters:
validate- whether to validate the header name contains only allowed characters- Returns:
- updated builder instance
-