java.lang.Object
io.helidon.webclient.WebClient.Builder
- All Implemented Interfaces:
Builder<WebClient.Builder,,WebClient> MediaContextBuilder<WebClient.Builder>,ParentingMediaContextBuilder<WebClient.Builder>,Supplier<WebClient>
- Enclosing interface:
- WebClient
public static final class WebClient.Builder
extends Object
implements 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) Adds new instance ofMediaSupport.addReader(MessageBodyReader<?> reader) Registers new reader.addService(WebClientService service) Register new instance ofWebClientService.addService(Supplier<? extends WebClientService> serviceSupplier) Register new instance ofWebClientService.addStreamReader(MessageBodyStreamReader<?> streamReader) Registers new stream reader.addStreamWriter(MessageBodyStreamWriter<?> streamWriter) Registers new stream writer.addWriter(MessageBodyWriter<?> writer) Registers new writer.Sets base uri for each request.Sets base uri for each request.Sets base url for each request.build()Build the instance from this builder.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 theMediaContextparent and overrides the existing one.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.
-
Method Details
-
build
Description copied from interface:BuilderBuild the instance from this builder.- Specified by:
buildin interfaceBuilder<WebClient.Builder,WebClient> - Returns:
- instance of the built type
-
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
Description copied from interface:ParentingMediaContextBuilderSets theMediaContextparent and overrides the existing one. This method discards all previously registered readers and writers via builder.- Specified by:
mediaContextin interfaceParentingMediaContextBuilder<WebClient.Builder>- Parameters:
mediaContext- media context- Returns:
- updated instance of the builder
-
addMediaSupport
Description copied from interface:MediaContextBuilderAdds new instance ofMediaSupport.- Specified by:
addMediaSupportin interfaceMediaContextBuilder<WebClient.Builder>- Parameters:
mediaSupport- media support- Returns:
- updated instance of the builder
-
addReader
Description copied from interface:MediaContextBuilderRegisters new reader.- Specified by:
addReaderin interfaceMediaContextBuilder<WebClient.Builder>- Parameters:
reader- reader- Returns:
- updated instance of the builder
-
addStreamReader
Description copied from interface:MediaContextBuilderRegisters new stream reader.- Specified by:
addStreamReaderin interfaceMediaContextBuilder<WebClient.Builder>- Parameters:
streamReader- stream reader- Returns:
- updated instance of the builder
-
addWriter
Description copied from interface:MediaContextBuilderRegisters new writer.- Specified by:
addWriterin interfaceMediaContextBuilder<WebClient.Builder>- Parameters:
writer- writer- Returns:
- updated instance of the builder
-
addStreamWriter
Description copied from interface:MediaContextBuilderRegisters new stream writer.- Specified by:
addStreamWriterin interfaceMediaContextBuilder<WebClient.Builder>- Parameters:
streamWriter- stream writer- Returns:
- updated instance of the 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
-