com.screenscraper.util.internal.services.proxypool

Class ProxyPoolClient.ProxyPoolClientBuilder

java.lang.Object

com.screenscraper.util.internal.services.proxypool.ProxyPoolClient.ProxyPoolClientBuilder

Enclosing class:

ProxyPoolClient

public static class ProxyPoolClient.ProxyPoolClientBuilder
extends java.lang.Object

Class used to build a proxy pool client since there are many parameters.

Constructor Summary

Constructors

Constructor and Description
ProxyPoolClientBuilder() Creates a builder with default values

Method Summary

Modifier and Type	Method and Description
ProxyPoolClient	build() Builds the proxy client with the current parameters
ProxyPoolClient.ProxyPoolClientBuilder	countryCode(java.lang.String countryCode) Sets the countries that proxies must be in to be set by the proxy pool client
ProxyPoolClient.ProxyPoolClientBuilder	countryCodes(java.util.Collection<java.lang.String> countryCodes) Sets the countries that proxies must be in to be set by the proxy pool client
ProxyPoolClient.ProxyPoolClientBuilder	countryCodes(java.lang.String... countryCodes) Sets the countries that proxies must be in to be set by the proxy pool client
ProxyPoolClient.ProxyPoolClientBuilder	domain(java.lang.String domain) Sets the domain the proxies will be used for
ProxyPoolClient.ProxyPoolClientBuilder	numTries(int numTries) Sets how many times the client will attempt to get a new proxy before failing
ProxyPoolClient.ProxyPoolClientBuilder	password(java.lang.String password) Sets the password for accessing the proxy service
ProxyPoolClient.ProxyPoolClientBuilder	proxyServiceUrl(java.lang.String proxyServiceUrl) Sets the URL the proxy service is located at
ProxyPoolClient.ProxyPoolClientBuilder	proxyType(ProxyPoolClient.ProxyType proxyType) Sets the type that proxies must be to be set by the proxy pool client
ProxyPoolClient.ProxyPoolClientBuilder	proxyTypes(java.util.Collection<ProxyPoolClient.ProxyType> proxyTypes) Sets the types that proxies must be in to be set by the proxy pool client
ProxyPoolClient.ProxyPoolClientBuilder	proxyTypes(ProxyPoolClient.ProxyType... proxyTypes) Sets the types that proxies must be in to be set by the proxy pool client
ProxyPoolClient.ProxyPoolClientBuilder	session(ScrapingSession session) Sets the session
ProxyPoolClient.ProxyPoolClientBuilder	terminateScrapeOnError(boolean terminateScrapeOnError) Sets whether or not the client will terminate the scrape if it fails to get a proxy
java.lang.String	toString()
ProxyPoolClient.ProxyPoolClientBuilder	username(java.lang.String username) Sets the username for accessing the proxy service

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyPoolClientBuilder

public ProxyPoolClientBuilder()

Creates a builder with default values

Method Detail

session

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder session(@Nullable
                                                                ScrapingSession session)

Sets the session

Parameters:

session - The scraping session being run

Returns:

The builder, for chaining the build methods

numTries

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder numTries(int numTries)

Sets how many times the client will attempt to get a new proxy before failing

Parameters:

numTries - How many times to attempt finding a new proxy before failing

Returns:

The builder, for chaining the build methods

proxyServiceUrl

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder proxyServiceUrl(@Nullable
                                                                        java.lang.String proxyServiceUrl)

Sets the URL the proxy service is located at

Parameters:

proxyServiceUrl - The URL where the proxy service is located

Returns:

The builder, for chaining the build methods

terminateScrapeOnError

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder terminateScrapeOnError(boolean terminateScrapeOnError)

Sets whether or not the client will terminate the scrape if it fails to get a proxy

Parameters:

terminateScrapeOnError - True if the proxy pool client should terminate the scrape if it fails to find a (new) proxy.

Returns:

The builder, for chaining the build methods

domain

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder domain(@Nullable
                                                               java.lang.String domain)

Sets the domain the proxies will be used for

Parameters:

domain - The domain the proxy pool will request proxies for

Returns:

The builder, for chaining the build methods

countryCodes

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder countryCodes(@Nullable
                                                                     java.util.Collection<java.lang.String> countryCodes)

Sets the countries that proxies must be in to be set by the proxy pool client

Parameters:

countryCodes - The country codes to get proxies in, or null (or empty) to indicate any country is fine

Returns:

The builder, for chaining the build methods

countryCodes

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder countryCodes(@Nullable
                                                                     java.lang.String... countryCodes)

Sets the countries that proxies must be in to be set by the proxy pool client

Parameters:

countryCodes - The country codes to get proxies in, or null (or empty) to indicate any country is fine

Returns:

The builder, for chaining the build methods

countryCode

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder countryCode(@Nullable
                                                                    java.lang.String countryCode)

Sets the countries that proxies must be in to be set by the proxy pool client

Parameters:

countryCode - The country code to get proxies in, or null to indicate any country is fine

Returns:

The builder, for chaining the build methods

proxyTypes

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder proxyTypes(@Nullable
                                                                   java.util.Collection<ProxyPoolClient.ProxyType> proxyTypes)

Sets the types that proxies must be in to be set by the proxy pool client

Parameters:

proxyTypes - The country codes to get proxies in, or null (or empty) to indicate any type is fine

Returns:

The builder, for chaining the build methods

proxyTypes

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder proxyTypes(@Nullable
                                                                   ProxyPoolClient.ProxyType... proxyTypes)

Sets the types that proxies must be in to be set by the proxy pool client

Parameters:

proxyTypes - The country codes to get proxies in, or null (or empty) to indicate any type is fine

Returns:

The builder, for chaining the build methods

proxyType

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder proxyType(@Nullable
                                                                  ProxyPoolClient.ProxyType proxyType)

Sets the type that proxies must be to be set by the proxy pool client

Parameters:

proxyType - The country code to get proxies in, or null to indicate any type is fine

Returns:

The builder, for chaining the build methods

username

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder username(@Nullable
                                                                 java.lang.String username)

Sets the username for accessing the proxy service

Parameters:

username - The username required for the service

Returns:

The builder, for chaining the build methods

password

@NotNull
public ProxyPoolClient.ProxyPoolClientBuilder password(@Nullable
                                                                 java.lang.String password)

Sets the password for accessing the proxy service

Parameters:

password - The password for using the proxy service

Returns:

The builder, for chaining the build methods

build

@NotNull
public ProxyPoolClient build()

Builds the proxy client with the current parameters

Returns:

The new proxy client

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object