Class ProxySearch

java.lang.Object

com.github.markusbernhardt.proxy.ProxySearch

All Implemented Interfaces:

ProxySearchStrategy

public class ProxySearch
extends Object
implements ProxySearchStrategy

Main class to setup and initialize the proxy detection system.
This class can be used to select a proxy discovery strategy.
Implements the "Builder" pattern.
Use addStrategy to add one or more search strategies.
If you are done call the getProxySelector method.
Then the strategies are asked one after the other for a ProxySelector until an valid selector is found.

Invoke the static getDefaultProxySearch method to use a default search strategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProxySearch.Strategy	Types of proxy detection supported by the builder.

Field Summary

Fields

Modifier and Type	Field	Description
private static final BufferedProxySelector.CacheScope	DEFAULT_PAC_CACHE_SCOPE
private static final int	DEFAULT_PAC_CACHE_SIZE
private static final long	DEFAULT_PAC_CACHE_TTL
private BufferedProxySelector.CacheScope	pacCacheScope
private int	pacCacheSize
private long	pacCacheTTL
private List<ProxySearchStrategy>	strategies

Constructor Summary

Constructors

Constructor	Description
ProxySearch()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addStrategy(ProxySearch.Strategy strategy)	Adds an search strategy to the list of proxy searches strategies.
private ProxySearchStrategy	getDefaultBrowserStrategy()	Gets the search strategy for the platforms default browser.
static ProxySearch	getDefaultProxySearch()	Sets up a ProxySearch that uses a default search strategy suitable for every platform.
String	getName()	Gets the printable name of the search strategy.
ProxySelector	getProxySelector()	Gets the proxy selector that will use the configured search order.
private ProxySelector	installBufferingAndFallbackBehaviour(ProxySelector selector)	If it is PAC and we have caching enabled set it here.
static void	main(String[] args)	For testing only.
void	setPacCacheSettings(int size, long ttl, BufferedProxySelector.CacheScope cacheScope)	Sets the cache size of the PAC proxy selector cache.
String	toString()	toString

Methods inherited from class Object

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

Field Details

DEFAULT_PAC_CACHE_SIZE

private static final int DEFAULT_PAC_CACHE_SIZE

See Also:

• Constant Field Values

DEFAULT_PAC_CACHE_TTL

private static final long DEFAULT_PAC_CACHE_TTL

See Also:

• Constant Field Values

DEFAULT_PAC_CACHE_SCOPE

private static final BufferedProxySelector.CacheScope DEFAULT_PAC_CACHE_SCOPE

strategies

private List<ProxySearchStrategy> strategies

pacCacheSize

private int pacCacheSize

pacCacheTTL

private long pacCacheTTL

pacCacheScope

private BufferedProxySelector.CacheScope pacCacheScope

Constructor Details

ProxySearch

public ProxySearch()

Constructor

Method Details

getDefaultProxySearch

public static ProxySearch getDefaultProxySearch()

Sets up a ProxySearch that uses a default search strategy suitable for every platform.

Returns:

a ProxySearch initialized with default settings.

addStrategy

public void addStrategy(ProxySearch.Strategy strategy)

Adds an search strategy to the list of proxy searches strategies.

Parameters:

strategy - the search strategy to add.

setPacCacheSettings

public void setPacCacheSettings(int size,
 long ttl,
 BufferedProxySelector.CacheScope cacheScope)

Sets the cache size of the PAC proxy selector cache. This defines the number of URLs that are cached together with the PAC script result. This improves performance because for URLs that are in the cache the script is not executed again. You have to set this before you add any strategies that may create a PAC script proxy selector.

Parameters:

size - of the cache. Set it to 0 to disable caching.

ttl - is the time to live of the cache entries as amount of milliseconds.

cacheScope - the desired cache scope.

getDefaultBrowserStrategy

private ProxySearchStrategy getDefaultBrowserStrategy()

Gets the search strategy for the platforms default browser.

Returns:

a ProxySearchStrategy, null if no supported browser was found.

getProxySelector

public ProxySelector getProxySelector()

Gets the proxy selector that will use the configured search order.

Specified by:

getProxySelector in interface ProxySearchStrategy

Returns:

a ProxySelector, null if none was found for the current builder configuration.

getName

public String getName()

Gets the printable name of the search strategy.

Specified by:

getName in interface ProxySearchStrategy

Returns:

the printable name of the search strategy

installBufferingAndFallbackBehaviour

private ProxySelector installBufferingAndFallbackBehaviour(ProxySelector selector)

If it is PAC and we have caching enabled set it here.

Parameters:

selector - the proxy selector to wrap

Returns:

the wrapped proxy selector or the passed in selector if nothing is done.

toString

public String toString()

toString

Overrides:

toString in class Object

See Also:

• Object.toString()

main

public static void main(String[] args)

For testing only. Will print the logging & proxy information to the console.

Parameters:

args - the command line arguments.