io.dropwizard.client.proxy

Class ProxyConfiguration

java.lang.Object

io.dropwizard.client.proxy.ProxyConfiguration

public class ProxyConfiguration
extends Object

Configuration of access to a remote host through a proxy server

Configuration Parameters:

Name	Default	Description
host	REQUIRED	The proxy server host name or ip address.
port	scheme default	The proxy server port. If the port is not set then the scheme default port is used.
scheme	http	The proxy server URI scheme. HTTP and HTTPS schemas are permitted. By default HTTP scheme is used.
auth	(none)	The proxy server AuthConfiguration BASIC authentication credentials. If they are not set then no credentials will be passed to the server.
nonProxyHosts	(none)	List of patterns of hosts that should be reached without proxy. The patterns may contain symbol '*' as a wildcard. If a host matches one of the patterns it will be reached through a direct connection.

Constructor Summary

Constructors

Constructor and Description
ProxyConfiguration()
ProxyConfiguration(@NotNull String host)
ProxyConfiguration(@NotNull String host, int port)
ProxyConfiguration(@NotNull String host, int port, String scheme, AuthConfiguration auth)

Method Summary

Modifier and Type	Method and Description
AuthConfiguration	getAuth()
String	getHost()
List<String>	getNonProxyHosts()
Integer	getPort()
String	getScheme()
void	setAuth(AuthConfiguration auth)
void	setHost(String host)
void	setNonProxyHosts(List<String> nonProxyHosts)
void	setPort(Integer port)
void	setScheme(String scheme)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyConfiguration

public ProxyConfiguration()

ProxyConfiguration

public ProxyConfiguration(@NotNull
                          @NotNull String host)

ProxyConfiguration

public ProxyConfiguration(@NotNull
                          @NotNull String host,
                          int port)

ProxyConfiguration

public ProxyConfiguration(@NotNull
                          @NotNull String host,
                          int port,
                          String scheme,
                          AuthConfiguration auth)

Method Detail

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

getScheme

public String getScheme()

setScheme

public void setScheme(String scheme)

getNonProxyHosts

@Nullable
public List<String> getNonProxyHosts()

setNonProxyHosts

public void setNonProxyHosts(List<String> nonProxyHosts)

getAuth

@Nullable
public AuthConfiguration getAuth()

setAuth

public void setAuth(AuthConfiguration auth)