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()

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    WsClientConfig.Builder
    Fluent API builder for WsClient.
    static class 
    WsClientConfig.BuilderBase<BUILDER extends WsClientConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientConfig>
    Fluent API builder base for WsClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    static WsClientConfig.Builder
    builder()
    Create a new fluent API builder to customize configuration.
    static WsClientConfig.Builder
    builder(WsClientConfig instance)
    Create a new fluent API builder from an existing instance.
    static WsClientConfig
    create()
    Create a new instance with default values.
    static WsClientConfig
    create(io.helidon.common.config.Config config)
    Deprecated.
    use create(io.helidon.config.Config)
    static WsClientConfig
    create(io.helidon.config.Config config)
    Create a new instance from configuration.
    default io.helidon.http.ClientRequestHeaders
    defaultRequestHeaders()
     
    WsClientProtocolConfig
    protocolConfig()
    WebSocket specific configuration.

    Methods inherited from interface io.helidon.webclient.api.HttpClientConfig

    baseFragment, baseQuery, baseUri, connectionCacheSize, contentEncoding, cookieManager, defaultHeadersMap, dnsAddressLookup, dnsResolver, executor, headers, maxInMemoryEntity, mediaContext, mediaSupports, mediaTypeParserMode, readContinueTimeout, relativeUris, sendExpectContinue, services, shareConnectionCache, socketOptions, writeBufferSize

    Methods inherited from interface io.helidon.webclient.api.HttpConfigBase

    connectTimeout, followRedirects, keepAlive, maxRedirects, properties, proxy, readTimeout, tls

    Methods inherited from interface io.helidon.builder.api.Prototype.Factory

    build

  • 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.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

      @Deprecated static WsClientConfig create(io.helidon.common.config.Config config)
      Deprecated.
      use create(io.helidon.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

    • defaultRequestHeaders

      default io.helidon.http.ClientRequestHeaders defaultRequestHeaders()