Proxy.Builder (Helidon Project 2.6.13 API)

java.lang.Object
- io.helidon.webclient.Proxy.Builder

All Implemented Interfaces:

Builder<Proxy>, Supplier<Proxy>

Enclosing class:

Proxy
```
public static class Proxy.Builder
extends Object
implements Builder<Proxy>
```
Fluent API builder for Proxy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Proxy.Builder`	`addNoProxy(String noProxyHost)`	Configure a host pattern that is not going through a proxy.
`Proxy`	`build()`	Build the instance from this builder.
`Proxy.Builder`	`config(Config config)`	Configure a metric from configuration.
`Proxy.Builder`	`host(String host)`	Sets a new host value.
`Proxy.Builder`	`password(char[] password)`	Sets a new password for the proxy.
`Proxy.Builder`	`port(int port)`	Sets a port value.
`Proxy.Builder`	`type(Proxy.ProxyType type)`	Sets a new proxy type.
`Proxy.Builder`	`username(String username)`	Sets a new username for the proxy.
`Proxy.Builder`	`useSystemSelector(boolean useIt)`	Configure proxy from environment variables and system properties.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.common.Builder
get

Method Detail

build
```
public Proxy build()
```
Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface 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
use-system-selector	`false`	Whether system proxy selector should be used
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
no-proxy	`no default`	Contains list of the hosts which should be excluded from using proxy

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

host
```
public Proxy.Builder host(String host)
```
Sets a new host value.

Parameters:

host - host

Returns:

updated builder instance

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 pattern that is not going through a proxy.
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
Parameters:

noProxyHost - to exclude from proxying

Returns:

updated builder instance

useSystemSelector
```
public Proxy.Builder useSystemSelector(boolean useIt)
```
Configure proxy from environment variables and system properties.

Parameters:

useIt - use system selector

Returns:

updated builder instance