Module io.helidon.webclient.websocket
Package io.helidon.webclient.websocket

Interface WsClientConfig

All Superinterfaces:
io.helidon.webclient.api.HttpClientConfig, io.helidon.webclient.api.HttpConfigBase, io.helidon.builder.api.Prototype.Api, io.helidon.builder.api.Prototype.Factory<WsClient>
All Known Implementing Classes:
WsClientConfig.BuilderBase.WsClientConfigImpl
public interface WsClientConfig extends io.helidon.builder.api.Prototype.Api, io.helidon.webclient.api.HttpClientConfig
WebSocket full webclient configuration. The client configuration also contains all necessary configuration for HTTP, as WebSocket upgrades from HTTP.
See Also:
  • WebClient.client(io.helidon.webclient.spi.Protocol, io.helidon.webclient.spi.ProtocolConfig)
  • builder()
  • create()

  • Method Details

    • builder

      static WsClientConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static WsClientConfig.Builder builder(WsClientConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static WsClientConfig create(io.helidon.common.config.Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static WsClientConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • protocolConfig

      WsClientProtocolConfig protocolConfig()
      WebSocket specific configuration.
      Returns:
      protocol specific configuration

    • baseUri

      Optional<io.helidon.webclient.api.ClientUri> baseUri()

    • baseQuery

      Optional<io.helidon.common.uri.UriQuery> baseQuery()

    • baseFragment

      Optional<io.helidon.common.uri.UriFragment> baseFragment()

    • socketOptions

      io.helidon.common.socket.SocketOptions socketOptions()

    • dnsResolver

      io.helidon.webclient.spi.DnsResolver dnsResolver()

    • dnsAddressLookup

      io.helidon.webclient.api.DnsAddressLookup dnsAddressLookup()

    • defaultHeadersMap

      Map<String,String> defaultHeadersMap()

    • headers

      Set<io.helidon.http.Header> headers()

    • defaultRequestHeaders

      default io.helidon.http.ClientRequestHeaders defaultRequestHeaders()

    • mediaTypeParserMode

      io.helidon.common.media.type.ParserMode mediaTypeParserMode()

    • contentEncoding

      io.helidon.http.encoding.ContentEncodingContext contentEncoding()

    • mediaContext

      io.helidon.http.media.MediaContext mediaContext()

    • mediaSupports

      List<io.helidon.http.media.MediaSupport> mediaSupports()

    • services

      List<io.helidon.webclient.spi.WebClientService> services()

    • relativeUris

      boolean relativeUris()

    • executor

      ExecutorService executor()

    • sendExpectContinue

      boolean sendExpectContinue()

    • connectionCacheSize

      int connectionCacheSize()

    • cookieManager

      Optional<io.helidon.webclient.api.WebClientCookieManager> cookieManager()

    • readContinueTimeout

      Duration readContinueTimeout()

    • shareConnectionCache

      boolean shareConnectionCache()

    • maxInMemoryEntity

      int maxInMemoryEntity()

    • followRedirects

      boolean followRedirects()

    • maxRedirects

      int maxRedirects()

    • tls

      io.helidon.common.tls.Tls tls()

    • readTimeout

      Optional<Duration> readTimeout()

    • connectTimeout

      Optional<Duration> connectTimeout()

    • keepAlive

      boolean keepAlive()

    • proxy

      io.helidon.webclient.api.Proxy proxy()

    • properties

      Map<String,String> properties()