ProxyConfiguration (AWS SDK for Java - OpenSdk Runtime 1.11.339 API)

java.lang.Object
- com.amazonaws.opensdk.config.ProxyConfiguration

public class ProxyConfiguration
extends Object

Options to route the request through a proxy.

Constructor Summary

Constructors
Constructor and Description

ProxyConfiguration()

Constructors
Constructor and Description
`ProxyConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<String>`	`getNonProxyHosts()` Returns the optional hosts the client will access without going through the proxy.
`Optional<Protocol>`	`getProtocol()` Returns the protocol (HTTP or HTTPS) to use when connecting through proxy.
`Optional<String>`	`getProxyDomain()` Returns the optional Windows domain name for configuring an NTLM proxy.
`Optional<String>`	`getProxyHost()` Returns the optional proxy host the client will connect through.
`Optional<String>`	`getProxyPassword()` Returns the optional proxy password to use if connecting through a proxy.
`Optional<Integer>`	`getProxyPort()` Returns either the proxyPort set on this object, or if not provided, checks the value of the Java system property for proxy port according to `getProtocol()`: i.e.
`Optional<String>`	`getProxyUsername()` Returns the optional proxy user name to use if connecting through a proxy.
`Optional<String>`	`getProxyWorkstation()` Returns the optional Windows workstation name for configuring NTLM proxy support.
`Optional<Boolean>`	`isPreemptiveBasicProxyAuth()` Returns whether to attempt to authenticate preemptively against proxy servers using basic authentication.
`ProxyConfiguration`	`nonProxyHosts(String nonProxyHosts)` Set the optional hosts the client will access without going through the proxy.
`ProxyConfiguration`	`preemptiveBasicProxyAuth(boolean preemptiveBasicProxyAuth)` Sets whether to attempt to authenticate preemptively against proxy servers using basic authentication.
`ProxyConfiguration`	`protocol(Protocol protocol)` Sets the protocol (i.e.
`ProxyConfiguration`	`proxyDomain(String proxyDomain)` Sets the optional Windows domain name for configuration an NTLM proxy.
`ProxyConfiguration`	`proxyHost(String proxyHost)` Sets the optional proxy host the client will connect through.
`ProxyConfiguration`	`proxyPassword(String proxyPassword)` Sets the optional proxy password to use when connecting through a proxy.
`ProxyConfiguration`	`proxyPort(int proxyPort)` Sets the proxy port the client will connect through.
`ProxyConfiguration`	`proxyUsername(String proxyUsername)` Sets the optional proxy user name to use if connecting through a proxy.
`ProxyConfiguration`	`proxyWorkstation(String proxyWorkstation)` Sets the optional Windows workstation name for configuring NTLM proxy support.
`void`	`setNonProxyHosts(String nonProxyHosts)` Set the optional hosts the client will access without going through the proxy.
`void`	`setPreemptiveBasicProxyAuth(Boolean preemptiveBasicProxyAuth)` Sets whether to attempt to authenticate preemptively against proxy servers using basic authentication.
`void`	`setProtocol(Protocol protocol)` Sets the protocol (i.e.
`void`	`setProxyDomain(String proxyDomain)` Sets the optional Windows domain name for configuration an NTLM proxy.
`void`	`setProxyHost(String proxyHost)` Sets the optional proxy host the client will connect through.
`void`	`setProxyPassword(String proxyPassword)` Sets the optional proxy password to use when connecting through a proxy.
`void`	`setProxyPort(Integer proxyPort)` Sets the proxy port the client will connect through.
`void`	`setProxyUsername(String proxyUsername)` Sets the optional proxy user name to use if connecting through a proxy.
`void`	`setProxyWorkstation(String proxyWorkstation)` Sets the optional Windows workstation name for configuring NTLM proxy support.

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

- Constructor Detail
  - ProxyConfiguration
```
public ProxyConfiguration()
```
- Method Detail
  - getProtocol
```
public Optional<Protocol> getProtocol()
```
    Returns the protocol (HTTP or HTTPS) to use when connecting through proxy.
    The default configuration is to use HTTPS for all requests for increased security.
    
    Returns:
    
    The protocol to use when connecting through proxy.
  - setProtocol
```
public void setProtocol(Protocol protocol)
```
    Sets the protocol (i.e. HTTP or HTTPS) to use when connecting through proxy.
    The default configuration is to use HTTPS for all requests for increased security.
    
    Parameters:
    
    protocol - The protocol to use when connecting through proxy.
  - protocol
```
public ProxyConfiguration protocol(Protocol protocol)
```
    Sets the protocol (i.e. HTTP or HTTPS) to use when connecting through proxy.
    The default configuration is to use HTTPS for all requests for increased security.
    
    Parameters:
    
    protocol - The protocol to use when connecting through proxy.
    
    Returns:
    
    This object for method chaining.
  - getProxyHost
```
public Optional<String> getProxyHost()
```
    Returns the optional proxy host the client will connect through. Returns either the proxyHost set on this object, or if not provided, checks the value of the Java system property for proxy host according to getProtocol(): i.e. if protocol is https, returns the value of the system property https.proxyHost, otherwise returns value of http.proxyHost.
    
    Returns:
    
    The proxy host the client will connect through.
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Sets the optional proxy host the client will connect through.
    
    Parameters:
    
    proxyHost - The proxy host the client will connect through.
  - proxyHost
```
public ProxyConfiguration proxyHost(String proxyHost)
```
    Sets the optional proxy host the client will connect through.
    
    Parameters:
    
    proxyHost - The proxy host the client will connect through.
    
    Returns:
    
    This object for method chaining.
  - getProxyPort
```
public Optional<Integer> getProxyPort()
```
    Returns either the proxyPort set on this object, or if not provided, checks the value of the Java system property for proxy port according to getProtocol(): i.e. if protocol is https, returns the value of the system property https.proxyPort, otherwise returns value of http.proxyPort.
    
    Returns:
    
    The proxy port the client will connect through.
  - setProxyPort
```
public void setProxyPort(Integer proxyPort)
```
    Sets the proxy port the client will connect through.
    
    Parameters:
    
    proxyPort - The proxy port the client will connect through.
  - proxyPort
```
public ProxyConfiguration proxyPort(int proxyPort)
```
    Sets the proxy port the client will connect through.
    
    Parameters:
    
    proxyPort - The proxy port the client will connect through.
    
    Returns:
    
    This object for method chaining.
  - getProxyUsername
```
public Optional<String> getProxyUsername()
```
    Returns the optional proxy user name to use if connecting through a proxy. Returns either the proxyUsername set on this object, or if not provided, checks the value of the Java system property for proxy user name according to getProtocol(): i.e. if protocol is https, returns the value of the system property https.proxyUsername, otherwise returns value of http.proxyUsername.
    
    Returns:
    
    The optional proxy user name the configured client will use if connecting through a proxy.
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Sets the optional proxy user name to use if connecting through a proxy.
    
    Parameters:
    
    proxyUsername - The proxy user name to use if connecting through a proxy.
  - proxyUsername
```
public ProxyConfiguration proxyUsername(String proxyUsername)
```
    Sets the optional proxy user name to use if connecting through a proxy.
    
    Parameters:
    
    proxyUsername - The proxy user name to use if connecting through a proxy.
    
    Returns:
    
    This object for method chaining.
  - getProxyPassword
```
public Optional<String> getProxyPassword()
```
    Returns the optional proxy password to use if connecting through a proxy. Returns either the proxyPassword set on this object, or if not provided, checks the value of the Java system property for proxy password according to getProtocol(): i.e. if protocol is https, returns the value of the system property https.proxyPassword, otherwise returns value of http.proxyPassword.
    
    Returns:
    
    The password to use when connecting through a proxy.
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Sets the optional proxy password to use when connecting through a proxy.
    
    Parameters:
    
    proxyPassword - The password to use when connecting through a proxy.
  - proxyPassword
```
public ProxyConfiguration proxyPassword(String proxyPassword)
```
    Sets the optional proxy password to use when connecting through a proxy.
    
    Parameters:
    
    proxyPassword - The password to use when connecting through a proxy.
    
    Returns:
    
    This object for method chaining.
  - getProxyDomain
```
public Optional<String> getProxyDomain()
```
    Returns the optional Windows domain name for configuring an NTLM proxy. If you aren't using a Windows NTLM proxy, you do not need to set this field.
    
    Returns:
    
    The optional Windows domain name for configuring an NTLM proxy.
  - setProxyDomain
```
public void setProxyDomain(String proxyDomain)
```
    Sets the optional Windows domain name for configuration an NTLM proxy. If you aren't using a Windows NTLM proxy, you do not need to set this field.
    
    Parameters:
    
    proxyDomain - The optional Windows domain name for configuring an NTLM proxy.
  - proxyDomain
```
public ProxyConfiguration proxyDomain(String proxyDomain)
```
    Sets the optional Windows domain name for configuration an NTLM proxy. If you aren't using a Windows NTLM proxy, you do not need to set this field.
    
    Parameters:
    
    proxyDomain - The optional Windows domain name for configuring an NTLM proxy.
    
    Returns:
    
    This object for method chaining.
  - getProxyWorkstation
```
public Optional<String> getProxyWorkstation()
```
    Returns the optional Windows workstation name for configuring NTLM proxy support. If you aren't using a Windows NTLM proxy, you do not need to set this field.
    
    Returns:
    
    The optional Windows workstation name for configuring NTLM proxy support.
  - setProxyWorkstation
```
public void setProxyWorkstation(String proxyWorkstation)
```
    Sets the optional Windows workstation name for configuring NTLM proxy support. If you aren't using a Windows NTLM proxy, you do not need to set this field.
    
    Parameters:
    
    proxyWorkstation - The optional Windows workstation name for configuring NTLM proxy support.
  - proxyWorkstation
```
public ProxyConfiguration proxyWorkstation(String proxyWorkstation)
```
    Sets the optional Windows workstation name for configuring NTLM proxy support. If you aren't using a Windows NTLM proxy, you do not need to set this field.
    
    Parameters:
    
    proxyWorkstation - The optional Windows workstation name for configuring NTLM proxy support.
    
    Returns:
    
    This object for method chaining.
  - getNonProxyHosts
```
public Optional<String> getNonProxyHosts()
```
    Returns the optional hosts the client will access without going through the proxy. Returns either the nonProxyHosts set on this object, or if not provided, checks the value of the Java system property for nonProxyHosts according to getProtocol(): i.e. if protocol is https, returns null, otherwise returns value of http.nonProxyHosts.
    
    Returns:
    
    The hosts the client will connect through bypassing the proxy.
  - setNonProxyHosts
```
public void setNonProxyHosts(String nonProxyHosts)
```
    Set the optional hosts the client will access without going through the proxy.
    
    Parameters:
    
    nonProxyHosts - The hosts the client will access without going through the proxy.
  - nonProxyHosts
```
public ProxyConfiguration nonProxyHosts(String nonProxyHosts)
```
    Set the optional hosts the client will access without going through the proxy.
    
    Parameters:
    
    nonProxyHosts - The hosts the client will access without going through the proxy.
    
    Returns:
    
    This object for method chaining.
  - isPreemptiveBasicProxyAuth
```
public Optional<Boolean> isPreemptiveBasicProxyAuth()
```
    Returns whether to attempt to authenticate preemptively against proxy servers using basic authentication.
    
    Returns:
    
    Whether to authenticate preemptively against proxy server.
  - setPreemptiveBasicProxyAuth
```
public void setPreemptiveBasicProxyAuth(Boolean preemptiveBasicProxyAuth)
```
    Sets whether to attempt to authenticate preemptively against proxy servers using basic authentication.
    
    Parameters:
    
    preemptiveBasicProxyAuth - Whether to authenticate preemptively against proxy server.
  - preemptiveBasicProxyAuth
```
public ProxyConfiguration preemptiveBasicProxyAuth(boolean preemptiveBasicProxyAuth)
```
    Sets whether to attempt to authenticate preemptively against proxy servers using basic authentication.
    
    Parameters:
    
    preemptiveBasicProxyAuth - Whether to authenticate preemptively against proxy server.
    
    Returns:
    
    This object for method chaining.

Class ProxyConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProxyConfiguration

Method Detail

getProtocol

setProtocol

protocol

getProxyHost

setProxyHost

proxyHost

getProxyPort

setProxyPort

proxyPort

getProxyUsername

setProxyUsername

proxyUsername

getProxyPassword

setProxyPassword

proxyPassword

getProxyDomain

setProxyDomain

proxyDomain

getProxyWorkstation

setProxyWorkstation

proxyWorkstation

getNonProxyHosts

setNonProxyHosts

nonProxyHosts

isPreemptiveBasicProxyAuth

setPreemptiveBasicProxyAuth

preemptiveBasicProxyAuth