Package ratpack.http.client
Interface Proxy
-
public interface Proxy
Configuration data for an HTTP proxy to utilize for outbound requests usingHttpClient
.- Since:
- 1.8.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Proxy.ProxyProtocol
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ProxyCredentials
getCredentials()
The credentials to use when connecting to the proxy.java.lang.String
getHost()
The host that proxied requests will be sent.java.util.Collection<java.lang.String>
getNonProxyHosts()
A collection of patterns which if any or matched, the outgoing request will bypass the HTTP proxy.int
getPort()
The port on the proxy where proxied requests will be sent.Proxy.ProxyProtocol
getProtocol()
The protocol that should be used when connecting to the proxy server itself.
-
-
-
Method Detail
-
getProtocol
Proxy.ProxyProtocol getProtocol()
The protocol that should be used when connecting to the proxy server itself.- Returns:
- the protocol to use to connect to the proxy server
-
getHost
java.lang.String getHost()
The host that proxied requests will be sent.- Returns:
- The host that proxied requests will be sent.
-
getPort
int getPort()
The port on the proxy where proxied requests will be sent.- Returns:
- The port on the proxy where proxied requests will be sent.
-
getCredentials
@Nullable ProxyCredentials getCredentials()
The credentials to use when connecting to the proxy.- Returns:
- The credentials to use when connecting to the HTTP proxy, or null if authentication should not be used when connecting to the HTTP proxy.
-
getNonProxyHosts
java.util.Collection<java.lang.String> getNonProxyHosts()
A collection of patterns which if any or matched, the outgoing request will bypass the HTTP proxy.The format of the values in this list follow the standard Java Networking and Proxies standards.
- Returns:
- A collection of patterns which if any or matched, the outgoing request will bypass the HTTP proxy.
-
-