com.ibm.cos.v2.http.apache

Interface ProxyConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>, SdkBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

Enclosing class:

ProxyConfiguration

public static interface ProxyConfiguration.Builder
extends CopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

A builder for ProxyConfiguration.

All implementations of this interface are mutable and not thread safe.

Method Summary

Modifier and Type	Method and Description
ProxyConfiguration.Builder	addNonProxyHost(String nonProxyHost) Add a host that the client is allowed to access without going through the proxy.
ProxyConfiguration.Builder	endpoint(URI endpoint) Configure the endpoint of the proxy server that the SDK should connect through.
ProxyConfiguration.Builder	nonProxyHosts(Set<String> nonProxyHosts) Configure the hosts that the client is allowed to access without going through the proxy.
ProxyConfiguration.Builder	ntlmDomain(String proxyDomain) For NTLM proxies: Configure the Windows domain name to use when authenticating with the proxy.
ProxyConfiguration.Builder	ntlmWorkstation(String proxyWorkstation) For NTLM proxies: Configure the Windows workstation name to use when authenticating with the proxy.
ProxyConfiguration.Builder	password(String password) Configure the password to use when connecting through a proxy.
ProxyConfiguration.Builder	preemptiveBasicAuthenticationEnabled(Boolean preemptiveBasicAuthenticationEnabled) Configure whether to attempt to authenticate pre-emptively against the proxy server using basic authentication.
ProxyConfiguration.Builder	scheme(String scheme) The HTTP scheme to use for connecting to the proxy.
ProxyConfiguration.Builder	useEnvironmentVariableValues(Boolean useEnvironmentVariableValues) Option whether to use environment variable values for proxy configuration if any of the config options are missing.
ProxyConfiguration.Builder	username(String username) Configure the username to use when connecting through a proxy.
ProxyConfiguration.Builder	useSystemPropertyValues(Boolean useSystemPropertyValues) Option whether to use system property values from ProxySystemSetting if any of the config options are missing.

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

endpoint

ProxyConfiguration.Builder endpoint(URI endpoint)

Configure the endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.

username

ProxyConfiguration.Builder username(String username)

Configure the username to use when connecting through a proxy.

password

ProxyConfiguration.Builder password(String password)

Configure the password to use when connecting through a proxy.

ntlmDomain

ProxyConfiguration.Builder ntlmDomain(String proxyDomain)

For NTLM proxies: Configure the Windows domain name to use when authenticating with the proxy.

ntlmWorkstation

ProxyConfiguration.Builder ntlmWorkstation(String proxyWorkstation)

For NTLM proxies: Configure the Windows workstation name to use when authenticating with the proxy.

nonProxyHosts

ProxyConfiguration.Builder nonProxyHosts(Set<String> nonProxyHosts)

Configure the hosts that the client is allowed to access without going through the proxy.

addNonProxyHost

ProxyConfiguration.Builder addNonProxyHost(String nonProxyHost)

Add a host that the client is allowed to access without going through the proxy.

See Also:

ProxyConfiguration.nonProxyHosts()

preemptiveBasicAuthenticationEnabled

ProxyConfiguration.Builder preemptiveBasicAuthenticationEnabled(Boolean preemptiveBasicAuthenticationEnabled)

Configure whether to attempt to authenticate pre-emptively against the proxy server using basic authentication.

useSystemPropertyValues

ProxyConfiguration.Builder useSystemPropertyValues(Boolean useSystemPropertyValues)

Option whether to use system property values from ProxySystemSetting if any of the config options are missing.

This value is set to "true" by default which means SDK will automatically use system property values for options that are not provided during building the ProxyConfiguration object. To disable this behavior, set this value to "false".It is important to note that when this property is set to "true," all proxy settings will exclusively originate from system properties, and no partial settings will be obtained from EnvironmentVariableValues.

useEnvironmentVariableValues

ProxyConfiguration.Builder useEnvironmentVariableValues(Boolean useEnvironmentVariableValues)

Option whether to use environment variable values for proxy configuration if any of the config options are missing.

This value is set to "true" by default, which means the SDK will automatically use environment variable values for proxy configuration options that are not provided during the building of the ProxyConfiguration object. To disable this behavior, set this value to "false". It is important to note that when this property is set to "true," all proxy settings will exclusively originate from environment variableValues, and no partial settings will be obtained from SystemPropertyValues.

Comma-separated host names in the NO_PROXY environment variable indicate multiple hosts to exclude from proxy settings.

Parameters:

useEnvironmentVariableValues - The option whether to use environment variable values.

Returns:

This object for method chaining.

scheme

ProxyConfiguration.Builder scheme(String scheme)

The HTTP scheme to use for connecting to the proxy. Valid values are http and https.

The client defaults to http if none is given.

Parameters:

scheme - The proxy scheme.

Returns:

This object for method chaining.