Class Proxy.Builder

java.lang.Object
io.helidon.webclient.api.Proxy.Builder
All Implemented Interfaces:
Builder<Proxy.Builder, Proxy>, Supplier<Proxy>
Enclosing class:
Proxy
public static class Proxy.Builder extends Object implements Builder<Proxy.Builder, Proxy>
Fluent API builder for Proxy.

  • Method Details

    • build

      public Proxy build()
      Description copied from interface: Builder
      Build the instance from this builder.
      Specified by:
      build in interface Builder<Proxy.Builder, Proxy>
      Returns:
      instance of the built type

    • config

      public Proxy.Builder config(Config config)
      Configure a metric from configuration. The following configuration key are used:
      Client Metric configuration options
      key default description
      type no default Sets which type is this proxy. See Proxy.ProxyType
      host no default Host of the proxy
      port 80 Port of the proxy
      username no default Proxy username
      password no default Proxy password
      httpConnect false Specify whether the HTTP client will always execute HTTP CONNECT.
      no-proxy no default Contains host or IP patterns which should be excluded from using proxy. IP patterns require local DNS resolution of host names and bind a direct route to the matching address.
      Parameters:
      config - configuration to configure this proxy
      Returns:
      updated builder instance

    • type

      public Proxy.Builder type(Proxy.ProxyType type)
      Sets a new proxy type.
      Parameters:
      type - proxy type
      Returns:
      updated builder instance
      Throws:
      NullPointerException - when type is null

    • forceHttpConnect

      public Proxy.Builder forceHttpConnect(boolean forceHttpConnect)
      Forces HTTP CONNECT with the proxy server. Otherwise it will not execute HTTP CONNECT when the request is plain HTTP with no authentication.
      Parameters:
      forceHttpConnect - HTTP CONNECT
      Returns:
      updated builder instance

    • host

      public Proxy.Builder host(String host)
      Sets a new host value.
      Parameters:
      host - host
      Returns:
      updated builder instance
      Throws:
      NullPointerException - when host is null

    • port

      public Proxy.Builder port(int port)
      Sets a port value.
      Parameters:
      port - port
      Returns:
      updated builder instance

    • username

      public Proxy.Builder username(String username)
      Sets a new username for the proxy.
      Parameters:
      username - proxy username
      Returns:
      updated builder instance

    • password

      public Proxy.Builder password(char[] password)
      Sets a new password for the proxy.
      Parameters:
      password - proxy password
      Returns:
      updated builder instance

    • addNoProxy

      public Proxy.Builder addNoProxy(String noProxyHost)
      Configure a host or IP pattern that is not going through a proxy; IP patterns resolve host-name targets locally and bind direct routes to the matching address.

      Options are:

      • IP Address, such as 192.168.1.1
      • IP V6 Address, such as [2001:db8:85a3:8d3:1319:8a2e:370:7348]
      • Hostname, such as localhost
      • Domain name, such as helidon.io
      • Domain name and all sub-domains, such as .helidon.io (leading dot)
      • Combination of all options from above with a port, such as .helidon.io:80
      An IP address pattern requires local DNS resolution of host-name targets. When the resolved address matches, WebClient selects a direct route and retains that address for the connection attempt.
      Parameters:
      noProxyHost - to exclude from proxying
      Returns:
      updated builder instance