com.screenscraper.util

Class ProxyServer

java.lang.Object

com.screenscraper.util.ProxyServer

All Implemented Interfaces:

java.lang.Comparable

public class ProxyServer
extends java.lang.Object
implements java.lang.Comparable

Represents a proxy server that can be used for issuing requests and hiding the real IP of the machine making them

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
ProxyServer(java.lang.String proxyServer) Creates a new ProxyServer based on a String in the form: host:port.
ProxyServer(java.lang.String proxyServer, java.lang.String username, java.lang.String password) Creates a new ProxyServer based on a String in the form: host:port.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object object) Required by the Comparable interface.
void	dumpToLog() Dumps the proxy server to the log.
boolean	equals(java.lang.Object obj) Overriding equals.
java.lang.String	getDescription() Gets a description of the proxy server.
java.lang.String	getHost() Gets the host.
java.lang.String	getInstanceID() For AWS proxies, this gets the instance ID.
java.lang.String	getPassword()
int	getPort() Gets the port.
java.lang.String	getProblem() Gets a description of a problem that may have been found with this proxy.
long	getResponseTime() Gets the amount of time it took for the HTTP response to return when this proxy was filtered.
java.lang.String	getUsername()
int	hashCode()
boolean	isAlive() Indicates whether or not the server is currently alive.
boolean	isBlocked() Indicates whether or not the proxy is blocked (as determined when validating it).
boolean	isUnavailable() Indicates whether or not the proxy is unavailable.
protected void	setHost(java.lang.String host) Sets the host.
protected void	setPort(int port) Sets the port.
void	setResponseTime(long responseTime) Sets the amount of time it took for the HTTP response to return when this proxy was filtered.
java.lang.String	toString()
boolean	validate(int connectionTimeout, boolean validateHost) Validates the proxy and sets the response time.
boolean	waitTillIsAlive(ScrapingSessionNotifiable notifiable) Keeps trying till the proxy server is alive.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

ProxyServer

public ProxyServer(@Nullable
                   java.lang.String proxyServer)

Creates a new ProxyServer based on a String in the form: host:port.

Parameters:

proxyServer - A String representing the proxy.

ProxyServer

public ProxyServer(@Nullable
                   java.lang.String proxyServer,
                   java.lang.String username,
                   java.lang.String password)

Creates a new ProxyServer based on a String in the form: host:port.

Parameters:

proxyServer - A String representing the proxy.

username - The username

password - The password

Method Detail

getHost

@Nullable
public java.lang.String getHost()

Gets the host.

Returns:

The host.

setHost

protected void setHost(java.lang.String host)

Sets the host.

Parameters:

host - The host.

getPort

public int getPort()

Gets the port.

Returns:

The port.

setPort

protected void setPort(int port)

Sets the port.

Parameters:

port - The port.

getInstanceID

@Nullable
public java.lang.String getInstanceID()

For AWS proxies, this gets the instance ID.

Returns:

The AMI ID.

setResponseTime

public void setResponseTime(long responseTime)

Sets the amount of time it took for the HTTP response to return when this proxy was filtered.

Parameters:

responseTime - The amount of time.

getResponseTime

public long getResponseTime()

Gets the amount of time it took for the HTTP response to return when this proxy was filtered.

Returns:

The amount of time.

getDescription

@NotNull
public java.lang.String getDescription()

Gets a description of the proxy server.

Returns:

A string representing the proxy server

getProblem

@Nullable
public java.lang.String getProblem()

Gets a description of a problem that may have been found with this proxy.

Returns:

A human-readable description of the problem.

compareTo

public int compareTo(java.lang.Object object)

Required by the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - The object to compare to.

Returns:

An int indicating how the given object compares to this object.

validate

public boolean validate(int connectionTimeout,
                        boolean validateHost)

Validates the proxy and sets the response time.

Parameters:

connectionTimeout - The maximum number of seconds to wait when testing each proxy.

validateHost - Indicates whether or not the host should be validated as well.

Returns:

Whether or not the proxy is valid.

equals

public boolean equals(java.lang.Object obj)

Overriding equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - What we're comparing against.

Returns:

A boolean.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isBlocked

public boolean isBlocked()

Indicates whether or not the proxy is blocked (as determined when validating it). This will be set to true in the case of a non-200 response.

Returns:

A boolean.

isUnavailable

public boolean isUnavailable()

Indicates whether or not the proxy is unavailable. This will be set to true if screen-scraper times out when attempting to connect to the proxy. This most likely would indicate that the proxy is up, but that AWS is having some kind of problem that prohibits the proxy from being connected to.

Returns:

A boolean.

isAlive

public boolean isAlive()

Indicates whether or not the server is currently alive.

Returns:

A boolean.

waitTillIsAlive

public boolean waitTillIsAlive(ScrapingSessionNotifiable notifiable)

Keeps trying till the proxy server is alive.

Parameters:

notifiable - So we can do logging in here.

Returns:

A boolean indicating whether or not the proxy is alive.

dumpToLog

public void dumpToLog()

Dumps the proxy server to the log.

getUsername

@NotNull
public java.lang.String getUsername()

getPassword

@NotNull
public java.lang.String getPassword()

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object