HelidonHelidon4.5.2

io.helidon.webclient.api.WebClient

Description

WebClient configuration

Configuration options

KeyTypeDefaultDescription
default-headersMap<String, String>Default headers to be used in every request from configuration
follow-redirectsBooleantrueWhether to follow redirects
read-timeoutDurationRead timeout
content-encodingContentEncodingContextConfigure the listener specific io.helidon.http.encoding.ContentEncodingContext
media-contextMediaContextcreate()Configure the listener specific io.helidon.http.media.MediaContext
media-type-parser-modeParserModeSTRICTConfigure media type parsing mode for HTTP Content-Type header
keep-aliveBooleantrueDetermines if connection keep alive is enabled (NOT socket keep alive, but HTTP connection keep alive, to re-use the same connection for multiple requests)
share-connection-cacheBooleantrueWhether to share connection cache between all the WebClient instances in JVM
socket-optionsSocketOptionsSocket options for connections opened by this client
follow-cross-origin-entity-redirectsBooleanfalseWhether redirects that preserve request method and entity may be followed across origins
redirect-sensitive-headersList<HeaderName>Request header names to strip on cross-origin redirects
read-continue-timeoutDurationPT1SSocket 100-Continue read timeout
base-uriClientUriBase uri used by the client in all requests
connection-cache-sizeInteger256Maximal size of the connection cache for a single connection key
base-addressStringBase address used by the client in all requests
cookie-managerWebClientCookieManagerWebClient cookie manager
servicesList<WebClientService>WebClient services
protocol-preferenceList<String>List of HTTP protocol IDs by order of preference
filter-redirect-headersBooleantrueWhether headers sensitive to cross-origin redirects should be filtered before the redirected request is sent
relative-urisBooleanfalseCan be set to true to force the use of relative URIs in all requests, regardless of the presence or absence of proxies or no-proxy lists
send-expect-continueBooleantrueWhether Expect-100-Continue header is sent to verify server availability before sending an entity
connect-timeoutDurationConnect timeout
proxyProxyProxy configuration to be used for requests
max-in-memory-entityInteger131072If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance
services-discover-servicesBooleantrueWhether to enable automatic service discovery for services
max-redirectsInteger10Max number of followed redirects
protocol-configsList<ProtocolConfig>Configuration of client protocols
protocol-configs-discover-servicesBooleantrueWhether to enable automatic service discovery for protocol-configs
tlsTlsTLS configuration for any TLS request from this client
write-buffer-sizeInteger4096Buffer size used when writing data to the underlying socket on a client TCP connection
propertiesMap<String, String>Properties configured for this client

Usages


See the manifest for all available types.

Copyright © 2018, 2026 Oracle and/or its affiliates.