com.screenscraper.util.internal.services.proxyservice

Class LuminatiProxyManager

java.lang.Object

com.screenscraper.util.internal.services.proxyservice.LuminatiProxyManager

All Implemented Interfaces:

LogMappable

public class LuminatiProxyManager
extends java.lang.Object
implements LogMappable

Proxy Manager for use with Luminati. Once created the session is instrumented to use it

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
LuminatiProxyManager(ScrapingSession session, java.lang.String baseUsername, java.lang.String zone, java.lang.String password, java.lang.String proxyCountry) Creates the proxy manager

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	convertMap() Converts the current object into a mapping of key-value pairs that can be logged
java.lang.String	getProxyCountry() Returns the ProxyCountry for the object
java.lang.String	getZone() Returns the Zone for the object
void	refreshCurrentProxies() Refreshes all the current proxies.
void	setLastRequestAsBadProxy() Used to flag the last request as bad manually to indicate the proxy should be discarded
void	setNumberOfProxies(int numberOfProxies) Sets how many proxies should be in the pool at a given time
void	setProxyCountry(java.lang.String proxyCountry) Sets the country code proxies should come from
void	setRequestsPerProxyIp(int requestsPerProxyIp) Sets how many requests should be allowed from a given proxy ip before it is discarded
void	setUseProxies(boolean useProxies) Sets whether or not proxies should be used for future requests (allows toggling off as needed)
void	setZone(java.lang.String zone) Sets the Zone for the object

Methods inherited from class java.lang.Object

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

Constructor Detail

LuminatiProxyManager

public LuminatiProxyManager(@NotNull
                            ScrapingSession session,
                            @NotNull
                            java.lang.String baseUsername,
                            @NotNull
                            java.lang.String zone,
                            @NotNull
                            java.lang.String password,
                            @Nullable
                            java.lang.String proxyCountry)
                     throws java.net.UnknownHostException

Creates the proxy manager

Parameters:

session - The session to instrument for proxy use

baseUsername - The base username for luminati.

zone - The zone to use for requests.

password - The password for luminati

proxyCountry - The country code (or null/empty for any) proxies should come from

Throws:

java.net.UnknownHostException - On failure to resolve the luminati address with a DNS lookup

Method Detail

setLastRequestAsBadProxy

public void setLastRequestAsBadProxy()

Used to flag the last request as bad manually to indicate the proxy should be discarded

refreshCurrentProxies

public void refreshCurrentProxies()

Refreshes all the current proxies. This means all current proxies are removed so new proxies will be used for future requests

getProxyCountry

@Nullable
public java.lang.String getProxyCountry()

Returns the ProxyCountry for the object

Returns:

The ProxyCountry for the object

getZone

@NotNull
public java.lang.String getZone()

Returns the Zone for the object

Returns:

The Zone for the object

setZone

public void setZone(@NotNull
                    java.lang.String zone)

Sets the Zone for the object

Parameters:

zone - The new value for Zone

setNumberOfProxies

public void setNumberOfProxies(int numberOfProxies)

Sets how many proxies should be in the pool at a given time

Parameters:

numberOfProxies - How many proxies should be in the pool at a given time (must be at least 1)

setRequestsPerProxyIp

public void setRequestsPerProxyIp(int requestsPerProxyIp)

Sets how many requests should be allowed from a given proxy ip before it is discarded

Parameters:

requestsPerProxyIp - How many requests should be allowed from a given ip (must be at least 1)

setUseProxies

public void setUseProxies(boolean useProxies)

Sets whether or not proxies should be used for future requests (allows toggling off as needed)

Parameters:

useProxies - True if proxies should be used, false otherwise

setProxyCountry

public void setProxyCountry(@Nullable
                            java.lang.String proxyCountry)

Sets the country code proxies should come from

Parameters:

proxyCountry - The country code for proxies, or null/empty to allow any country

convertMap

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> convertMap()

Description copied from interface: LogMappable

Converts the current object into a mapping of key-value pairs that can be logged

Specified by:

convertMap in interface LogMappable

Returns:

The mapping of key-value pairs to then log