Class ProxyConfiguration
java.lang.Object
software.amazon.awssdk.http.apache.ProxyConfiguration
- All Implemented Interfaces:
ToCopyableBuilder<ProxyConfiguration.Builder,
ProxyConfiguration>
public final class ProxyConfiguration
extends Object
implements ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>
Configuration that defines how to communicate via an HTTP or HTTPS proxy.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ProxyConfiguration.Builder
builder()
Create aProxyConfiguration.Builder
, used to create aProxyConfiguration
.host()
Returns the proxy host name from the configured endpoint if set, else from the "https.proxyHost" or "http.proxyHost" system property, based on the scheme used, ifProxyConfiguration.Builder.useSystemPropertyValues(Boolean)
is set to true.The hosts that the client is allowed to access without going through the proxy.For NTLM proxies: The Windows domain name to use when authenticating with the proxy.For NTLM proxies: The Windows workstation name to use when authenticating with the proxy.password()
The password to use when connecting through a proxy.int
port()
Returns the proxy port from the configured endpoint if set, else from the "https.proxyPort" or "http.proxyPort" system property, based on the scheme used, ifProxyConfiguration.Builder.useSystemPropertyValues(Boolean)
is set to true.Whether to attempt to authenticate preemptively against the proxy server using basic authentication.scheme()
Returns theinvalid reference
URI#scheme
Take this object and create a builder that contains all of the current property values of this object.toString()
username()
The username to use when connecting through a proxy.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
host
Returns the proxy host name from the configured endpoint if set, else from the "https.proxyHost" or "http.proxyHost" system property, based on the scheme used, ifProxyConfiguration.Builder.useSystemPropertyValues(Boolean)
is set to true. -
port
public int port()Returns the proxy port from the configured endpoint if set, else from the "https.proxyPort" or "http.proxyPort" system property, based on the scheme used, ifProxyConfiguration.Builder.useSystemPropertyValues(Boolean)
is set to true. If no value is found in none of the above options, the default value of 0 is returned. -
scheme
Returns theinvalid reference
URI#scheme
-
username
The username to use when connecting through a proxy.- See Also:
-
password
The password to use when connecting through a proxy.- See Also:
-
ntlmDomain
For NTLM proxies: The Windows domain name to use when authenticating with the proxy.- See Also:
-
ntlmWorkstation
For NTLM proxies: The Windows workstation name to use when authenticating with the proxy.- See Also:
-
nonProxyHosts
The hosts that the client is allowed to access without going through the proxy. If the value is not set on the object, the value represent by "http.nonProxyHosts" system property is returned. If system property is also not set, an unmodifiable empty set is returned.- See Also:
-
preemptiveBasicAuthenticationEnabled
Whether to attempt to authenticate preemptively against the proxy server using basic authentication.- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProxyConfiguration.Builder,
ProxyConfiguration> - Returns:
- a builder for type T
-
builder
Create aProxyConfiguration.Builder
, used to create aProxyConfiguration
. -
toString
-
resolveScheme
-