Module io.helidon.webclient.api
Package io.helidon.webclient.api

Interface HttpConfigBase

All Superinterfaces:
Prototype.Api
All Known Subinterfaces:
GrpcClientConfig, io.helidon.webclient.grpc.GrpcClientConfigBlueprint, Http1ClientConfig, io.helidon.webclient.http1.Http1ClientConfigBlueprint, Http2ClientConfig, io.helidon.webclient.http2.Http2ClientConfigBlueprint, HttpClientConfig, JsonRpcClientConfig, io.helidon.webclient.jsonrpc.JsonRpcClientConfigBlueprint, WebClientConfig, WsClientConfig, io.helidon.webclient.websocket.WsClientConfigBlueprint
All Known Implementing Classes:
GrpcClientConfig.BuilderBase.GrpcClientConfigImpl, Http1ClientConfig.BuilderBase.Http1ClientConfigImpl, Http2ClientConfig.BuilderBase.Http2ClientConfigImpl, HttpClientConfig.BuilderBase.HttpClientConfigImpl, HttpConfigBase.BuilderBase.HttpConfigBaseImpl, JsonRpcClientConfig.BuilderBase.JsonRpcClientConfigImpl, WebClientConfig.BuilderBase.WebClientConfigImpl, WsClientConfig.BuilderBase.WsClientConfigImpl
public interface HttpConfigBase extends Prototype.Api
Common configuration for HTTP protocols.

  • Method Details

    • builder

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

    • builder

      static HttpConfigBase.Builder builder(HttpConfigBase 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 HttpConfigBase create(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 HttpConfigBase create(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

    • followRedirects

      boolean followRedirects()
      Whether to follow redirects.
      Returns:
      whether to follow redirects

    • maxRedirects

      int maxRedirects()
      Max number of followed redirects. This is ignored if followRedirects() option is false.
      Returns:
      max number of followed redirects

    • tls

      Tls tls()
      TLS configuration for any TLS request from this client. TLS can also be configured per request. TLS is used when the protocol is set to https.
      Returns:
      TLS configuration to use

    • readTimeout

      Optional<Duration> readTimeout()
      Read timeout.
      Returns:
      read timeout
      See Also:

    • connectTimeout

      Optional<Duration> connectTimeout()
      Connect timeout.
      Returns:
      connect timeout
      See Also:

    • keepAlive

      boolean keepAlive()
      Determines if connection keep alive is enabled (NOT socket keep alive, but HTTP connection keep alive, to re-use the same connection for multiple requests).
      Returns:
      keep alive for this connection
      See Also:

    • proxy

      Proxy proxy()
      Proxy configuration to be used for requests.
      Returns:
      proxy to use, defaults to Proxy.noProxy()

    • properties

      Map<String,String> properties()
      Properties configured for this client. These properties are propagated through client request, to be used by services (and possibly for other purposes).
      Returns:
      map of client properties