software.amazon.awssdk.crt.http

Class HttpProxyOptions

java.lang.Object

software.amazon.awssdk.crt.http.HttpProxyOptions

public class HttpProxyOptions
extends Object

This class provides access to Http proxy configuration options

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpProxyOptions.HttpProxyAuthorizationType what kind of authentication, if any, to use when connecting to a proxy server
static class	HttpProxyOptions.HttpProxyConnectionType What kind of proxy connection to establish

Constructor Summary

Constructors

Constructor and Description
HttpProxyOptions() Creates a new set of proxy options

Method Summary

Modifier and Type	Method and Description
String	getAuthorizationPassword()
HttpProxyOptions.HttpProxyAuthorizationType	getAuthorizationType()
String	getAuthorizationUsername()
HttpProxyOptions.HttpProxyConnectionType	getConnectionType()
String	getHost()
int	getPort()
TlsContext	getTlsContext()
void	setAuthorizationPassword(String password) Sets the password to use for authorization; only applicable to basic authentication
void	setAuthorizationType(HttpProxyOptions.HttpProxyAuthorizationType authorizationType) Sets the proxy authorization type
void	setAuthorizationUsername(String username) Sets the username to use for authorization; only applicable to basic authentication
void	setConnectionType(HttpProxyOptions.HttpProxyConnectionType connectionType) Sets the proxy connection type
void	setHost(String host) Sets the proxy host to connect through
void	setPort(int port) Sets the proxy port to connect through
void	setTlsContext(TlsContext tlsContext) Sets the tls context for the proxy connection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpProxyOptions

public HttpProxyOptions()

Creates a new set of proxy options

Throws:

CrtRuntimeException - If the system is unable to allocate space for a http proxy options instance

Method Detail

setConnectionType

public void setConnectionType(HttpProxyOptions.HttpProxyConnectionType connectionType)

Sets the proxy connection type

Parameters:

connectionType - what kind of connection to establish

getConnectionType

public HttpProxyOptions.HttpProxyConnectionType getConnectionType()

Returns:

the proxy connection type

setHost

public void setHost(String host)

Sets the proxy host to connect through

Parameters:

host - proxy to connect through

getHost

public String getHost()

Returns:

the proxy host to connect through

setPort

public void setPort(int port)

Sets the proxy port to connect through

Parameters:

port - proxy port to connect through

getPort

public int getPort()

Returns:

the proxy port to connect through

setAuthorizationType

public void setAuthorizationType(HttpProxyOptions.HttpProxyAuthorizationType authorizationType)

Sets the proxy authorization type

Parameters:

authorizationType - what kind of authentication, if any, to use

getAuthorizationType

public HttpProxyOptions.HttpProxyAuthorizationType getAuthorizationType()

Returns:

the proxy authorization type

setAuthorizationUsername

public void setAuthorizationUsername(String username)

Sets the username to use for authorization; only applicable to basic authentication

Parameters:

username - username to use with basic authentication

getAuthorizationUsername

public String getAuthorizationUsername()

Returns:

the username to use for authorization

setAuthorizationPassword

public void setAuthorizationPassword(String password)

Sets the password to use for authorization; only applicable to basic authentication

Parameters:

password - password to use with basic authentication

getAuthorizationPassword

public String getAuthorizationPassword()

Returns:

the password to use for authorization

setTlsContext

public void setTlsContext(TlsContext tlsContext)

Sets the tls context for the proxy connection

Parameters:

tlsContext - tls context for the proxy connection

getTlsContext

public TlsContext getTlsContext()

Returns:

the tls context for the proxy connection