Class ProxyConfiguration

java.lang.Object

software.amazon.awssdk.http.apache.ProxyConfiguration

All Implemented Interfaces:

ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

@SdkPublicApi
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

Nested Classes

Modifier and Type	Class	Description
static interface	ProxyConfiguration.Builder	A builder for ProxyConfiguration.

Method Summary

Modifier and Type	Method	Description
static ProxyConfiguration.Builder	builder()	Create a ProxyConfiguration.Builder, used to create a ProxyConfiguration.
String	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, if ProxyConfiguration.Builder.useSystemPropertyValues(Boolean) is set to true.
Set<String>	nonProxyHosts()	The hosts that the client is allowed to access without going through the proxy.
String	ntlmDomain()	For NTLM proxies: The Windows domain name to use when authenticating with the proxy.
String	ntlmWorkstation()	For NTLM proxies: The Windows workstation name to use when authenticating with the proxy.
String	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, if ProxyConfiguration.Builder.useSystemPropertyValues(Boolean) is set to true.
Boolean	preemptiveBasicAuthenticationEnabled()	Whether to attempt to authenticate preemptively against the proxy server using basic authentication.
String	resolveScheme()
String	scheme()	Returns the invalid reference URI#scheme from the configured endpoint.
ProxyConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	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

public String 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, if ProxyConfiguration.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, if ProxyConfiguration.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

public String scheme()

Returns the

invalid reference

URI#scheme

from the configured endpoint. Otherwise return null.

username

public String username()

The username to use when connecting through a proxy.

See Also:

• ProxyConfiguration.Builder.password(String)

password

public String password()

The password to use when connecting through a proxy.

See Also:

• ProxyConfiguration.Builder.password(String)

ntlmDomain

public String ntlmDomain()

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

See Also:

• ProxyConfiguration.Builder.ntlmDomain(String)

ntlmWorkstation

public String ntlmWorkstation()

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

See Also:

• ProxyConfiguration.Builder.ntlmWorkstation(String)

nonProxyHosts

public Set<String> 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:

• ProxyConfiguration.Builder.nonProxyHosts(Set)

preemptiveBasicAuthenticationEnabled

public Boolean preemptiveBasicAuthenticationEnabled()

Whether to attempt to authenticate preemptively against the proxy server using basic authentication.

See Also:

• ProxyConfiguration.Builder.preemptiveBasicAuthenticationEnabled(Boolean)

toBuilder

public ProxyConfiguration.Builder 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 interface ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

Returns:

a builder for type T

builder

public static ProxyConfiguration.Builder builder()

Create a ProxyConfiguration.Builder, used to create a ProxyConfiguration.

toString

public String toString()

Overrides:

toString in class Object

resolveScheme

public String resolveScheme()