Package org.eclipse.jetty.client

Class ProxyConfiguration

java.lang.Object

org.eclipse.jetty.client.ProxyConfiguration

public class ProxyConfiguration
extends Object

The configuration of the forward proxy to use with HttpClient.

Applications add subclasses of ProxyConfiguration.Proxy to this configuration via:

 ProxyConfiguration proxyConfig = httpClient.getProxyConfiguration();
 proxyConfig.addProxy(new HttpProxy(proxyHost, 8080));
 

See Also:

• HttpClient.getProxyConfiguration()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProxyConfiguration.Proxy

Constructor Summary

Constructors

Constructor	Description
ProxyConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addProxy(ProxyConfiguration.Proxy proxy)	Adds a proxy.
List<ProxyConfiguration.Proxy>	getProxies()	Deprecated. use addProxy(Proxy) and removeProxy(Proxy) instead
ProxyConfiguration.Proxy	match(Origin origin)
boolean	removeProxy(ProxyConfiguration.Proxy proxy)	Removes a proxy.

Methods inherited from class java.lang.Object

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

Constructor Details

ProxyConfiguration

public ProxyConfiguration()

Method Details

getProxies

@Deprecated
public List<ProxyConfiguration.Proxy> getProxies()

Deprecated.

use addProxy(Proxy) and removeProxy(Proxy) instead

Returns the list of proxies added to this configuration.

This method is deprecated because it has historically been used to add/remove proxies directly to/from the returned list, but this has now been replaced by addProxy(Proxy) and removeProxy(Proxy) instead.

In the future, this method will return an unmodifiable list of proxies just for querying purposes.

Returns:

the forward proxies to use

addProxy

public void addProxy(ProxyConfiguration.Proxy proxy)

Adds a proxy.

Parameters:

proxy - a proxy

Throws:

NullPointerException - if proxy is null

removeProxy

public boolean removeProxy(ProxyConfiguration.Proxy proxy)

Removes a proxy.

Parameters:

proxy - a proxy

Returns:

true if a match is found

match

public ProxyConfiguration.Proxy match(Origin origin)