com.screenscraper.scraper

Class RemoteScrapingSession

java.lang.Object

com.screenscraper.scraper.RemoteScrapingSession

public class RemoteScrapingSession
extends java.lang.Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RemoteScrapingSession(java.lang.String name) Generates a new remote session with the given name using the default settings.
RemoteScrapingSession(java.lang.String host, int port) Generates a new remote session without a session name.
RemoteScrapingSession(java.lang.String name, java.lang.String host, int port) Generates a new remote session with the given name using the given settings.
RemoteScrapingSession(java.lang.String name, java.lang.String host, int port, int timeout) Generates a new remote session with the given name using the given settings.
RemoteScrapingSession(java.lang.String name, java.lang.String host, int port, int timeout, java.lang.String characterSet) Generates a new remote session with the given name using the given settings.
RemoteScrapingSession(java.lang.String name, java.lang.String host, int port, java.lang.String characterSet) Generates a new remote session with the given name using the given settings.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnects from the remote server and cleans up.
void	doHotSwapFromDatabase() Indicates that a database hot swap needs to be performed.
java.lang.String	getCharacterSet() Gets the character set to use.
DataReceiver	getDataReceiver() Gets a reference to the DataReceiver object.
DataRecord	getDataRecordFromDataSet(java.lang.String dataSetName, int index) Gets the value of a data record found in a data set from the remote scraping session.
DataRecord	getNextCachedDataRecord(java.lang.String dataSetName) Gets the next data record from the given cached data set.
DataSet	getNextCachedDataRecords(java.lang.String dataSetName, int numRecordsToRetrive) Gets a DataSet containing up to the given number of records from a cached DataSet.
int	getNumDataRecordsInDataSet(java.lang.String dataSetName) Gets the number of data records found in a data set.
int	getPollFrequency() Gets the frequency with which screen-scraper should be polled for data.
java.lang.Object	getVariable(java.lang.String varName) Gets the value of a variable from the remote scraping session.
static java.lang.String	getVersion() Gets the version of the driver.
void	loadVariables(java.lang.String fileToReadFrom) Reads in and loads the session variables that was previously saved to a file.
void	scrape() Tells the remote scraping session to scrape.
boolean	sessionTimedOut() Indicates whether or not the session timed out.
void	setDataReceiver(DataReceiver dataReceiver) Sets the DataReceiver to be used.
void	setDoLazyScrape(boolean doLazyScrape) Indicates whether or not a lazy scrape should be done on the session.
void	setOutputLogFiles(boolean outputLogFiles) Indicates whether or not log files should be output.
void	setPollFrequency(int pollFrequency) Sets the frequency in seconds with which screen-scraper should be polled for data.
void	setTimeout(int timeout) Sets the timeout, in minutes, for the scraping session.
void	setVariable(java.lang.String varName, java.lang.Object value) Sets a session variable on the remote scraping session.
void	setVariable(java.lang.String varName, java.lang.String value) Sets a session variable on the remote scraping session.
void	stopServer() Tells the server to stop.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

RemoteScrapingSession

public RemoteScrapingSession(java.lang.String name)
                      throws RemoteScrapingSessionException,
                             java.net.UnknownHostException,
                             java.io.IOException

Generates a new remote session with the given name using the default settings.

Parameters:

name - The name of the scraping session.

Throws:

RemoteScrapingSessionException

java.net.UnknownHostException

java.io.IOException

RemoteScrapingSession

public RemoteScrapingSession(java.lang.String name,
                             @NotNull
                             java.lang.String host,
                             int port)
                      throws RemoteScrapingSessionException,
                             java.net.UnknownHostException,
                             java.io.IOException

Generates a new remote session with the given name using the given settings.

Parameters:

name - The name of the scraping session.

host - The host the client should try to connect to.

port - The port the client should try to connect to.

Throws:

RemoteScrapingSessionException

java.net.UnknownHostException

java.io.IOException

RemoteScrapingSession

public RemoteScrapingSession(java.lang.String name,
                             @NotNull
                             java.lang.String host,
                             int port,
                             int timeout)
                      throws RemoteScrapingSessionException,
                             java.net.UnknownHostException,
                             java.io.IOException

Generates a new remote session with the given name using the given settings.

Parameters:

name - The name of the scraping session.

host - The host the client should try to connect to.

port - The port the client should try to connect to.

timeout - The timeout value for the socket.

Throws:

RemoteScrapingSessionException

java.net.UnknownHostException

java.io.IOException

RemoteScrapingSession

public RemoteScrapingSession(java.lang.String name,
                             @NotNull
                             java.lang.String host,
                             int port,
                             java.lang.String characterSet)
                      throws RemoteScrapingSessionException,
                             java.net.UnknownHostException,
                             java.io.IOException

Generates a new remote session with the given name using the given settings.

Parameters:

name - The name of the scraping session.

host - The host the client should try to connect to.

port - The port the client should try to connect to.

characterSet - The character set to use when transferring data across the pipe.

Throws:

RemoteScrapingSessionException

java.net.UnknownHostException

java.io.IOException

RemoteScrapingSession

public RemoteScrapingSession(java.lang.String name,
                             @NotNull
                             java.lang.String host,
                             int port,
                             int timeout,
                             java.lang.String characterSet)
                      throws RemoteScrapingSessionException,
                             java.net.UnknownHostException,
                             java.io.IOException

Generates a new remote session with the given name using the given settings.

Parameters:

name - The name of the scraping session.

host - The host the client should try to connect to.

port - The port the client should try to connect to.

timeout - The timeout value for the socket.

characterSet - The character set to use when transferring data across the pipe.

Throws:

RemoteScrapingSessionException

java.net.UnknownHostException

java.io.IOException

RemoteScrapingSession

public RemoteScrapingSession(@NotNull
                             java.lang.String host,
                             int port)
                      throws RemoteScrapingSessionException,
                             java.net.UnknownHostException,
                             java.io.IOException

Generates a new remote session without a session name. Note that this is currently only used to stop the server.

Parameters:

host - The host the client should try to connect to.

port - The port the client should try to connect to.

Throws:

RemoteScrapingSessionException

java.net.UnknownHostException

java.io.IOException

Method Detail

scrape

public void scrape()
            throws RemoteScrapingSessionException

Tells the remote scraping session to scrape.

Throws:

RemoteScrapingSessionException

stopServer

public void stopServer()
                throws RemoteScrapingSessionException

Tells the server to stop.

Throws:

RemoteScrapingSessionException

getVariable

@Nullable
public java.lang.Object getVariable(@NotNull
                                               java.lang.String varName)
                                        throws RemoteScrapingSessionException

Gets the value of a variable from the remote scraping session. This is a copy of the variable on the server (not the actual object reference). Changes made to this object have no effect on the server's copy.

Parameters:

varName - The name of the desired variable.

Returns:

The value of the variable.

Throws:

RemoteScrapingSessionException

getNumDataRecordsInDataSet

public int getNumDataRecordsInDataSet(java.lang.String dataSetName)
                               throws RemoteScrapingSessionException

Gets the number of data records found in a data set.

Parameters:

dataSetName - The name of the data set.

Returns:

The number of data records.

Throws:

RemoteScrapingSessionException

getDataRecordFromDataSet

@NotNull
public DataRecord getDataRecordFromDataSet(java.lang.String dataSetName,
                                                     int index)
                                              throws RemoteScrapingSessionException

Gets the value of a data record found in a data set from the remote scraping session.

Parameters:

dataSetName - The name of the data set.

index - The index of the data record.

Returns:

The data record.

Throws:

RemoteScrapingSessionException

setVariable

public void setVariable(@NotNull
                        java.lang.String varName,
                        @Nullable
                        java.lang.Object value)
                 throws RemoteScrapingSessionException

Sets a session variable on the remote scraping session. This attempts to build a string representation of the variable to set, and passes that, which is then decoded on the server and reconstructed as an object. This won't preserve open resources, such as database connections or file handles. It also won't work for custom script classes. Any libraries needed for the class must be present on both the server and this instance.

Parameters:

varName - The name of the variable to be set.

value - The value to be set.

Throws:

RemoteScrapingSessionException - On error setting the variable on the remote session

setVariable

public void setVariable(@NotNull
                        java.lang.String varName,
                        @Nullable
                        java.lang.String value)
                 throws RemoteScrapingSessionException

Sets a session variable on the remote scraping session.

Parameters:

varName - The name of the variable to be set.

value - The value to be set.

Throws:

RemoteScrapingSessionException - On error setting the variable on the remote session

setTimeout

public void setTimeout(int timeout)
                throws RemoteScrapingSessionException

Sets the timeout, in minutes, for the scraping session.

Parameters:

timeout - The number of minutes before the session should time out.

Throws:

RemoteScrapingSessionException

sessionTimedOut

public boolean sessionTimedOut()
                        throws RemoteScrapingSessionException

Indicates whether or not the session timed out.

Returns:

A boolean.

Throws:

RemoteScrapingSessionException

setDoLazyScrape

public void setDoLazyScrape(boolean doLazyScrape)
                     throws RemoteScrapingSessionException

Indicates whether or not a lazy scrape should be done on the session. Defaults to false.

Throws:

RemoteScrapingSessionException

setOutputLogFiles

public void setOutputLogFiles(boolean outputLogFiles)
                       throws RemoteScrapingSessionException

Indicates whether or not log files should be output.

Throws:

RemoteScrapingSessionException

getNextCachedDataRecord

@Nullable
public DataRecord getNextCachedDataRecord(java.lang.String dataSetName)
                                              throws RemoteScrapingSessionException

Gets the next data record from the given cached data set.

Parameters:

dataSetName - The name of a cached data set.

Returns:

The DataRecord

Throws:

RemoteScrapingSessionException

getNextCachedDataRecords

@Nullable
public DataSet getNextCachedDataRecords(java.lang.String dataSetName,
                                                   int numRecordsToRetrive)
                                            throws RemoteScrapingSessionException

Gets a DataSet containing up to the given number of records from a cached DataSet.

Parameters:

dataSetName - The name of a cached data set.

numRecordsToRetrive - The number of records to be retrieved from the set.

Returns:

A DataSet containing up to the given number of records to be retrieved.

Throws:

RemoteScrapingSessionException

loadVariables

public void loadVariables(java.lang.String fileToReadFrom)
                   throws RemoteScrapingSessionException

Reads in and loads the session variables that was previously saved to a file.

Parameters:

fileToReadFrom - The file to read the variables from.

Throws:

RemoteScrapingSessionException

doHotSwapFromDatabase

public void doHotSwapFromDatabase()
                           throws RemoteScrapingSessionException

Indicates that a database hot swap needs to be performed.

Throws:

RemoteScrapingSessionException

disconnect

public void disconnect()
                throws java.io.IOException

Disconnects from the remote server and cleans up.

Throws:

java.io.IOException

getDataReceiver

@Nullable
public DataReceiver getDataReceiver()

Gets a reference to the DataReceiver object.

Returns:

A DataReceiver if we have one; null, otherwise.

setDataReceiver

public void setDataReceiver(DataReceiver dataReceiver)
                     throws RemoteScrapingSessionException

Sets the DataReceiver to be used.

Parameters:

dataReceiver - A DataReceiver.

Throws:

RemoteScrapingSessionException

getPollFrequency

public int getPollFrequency()

Gets the frequency with which screen-scraper should be polled for data.

Returns:

The frequency.

setPollFrequency

public void setPollFrequency(int pollFrequency)
                      throws RemoteScrapingSessionException

Sets the frequency in seconds with which screen-scraper should be polled for data.

Parameters:

pollFrequency - The frequency.

Throws:

RemoteScrapingSessionException

getVersion

@NotNull
public static java.lang.String getVersion()

Gets the version of the driver.

Returns:

The version.

getCharacterSet

public java.lang.String getCharacterSet()

Gets the character set to use.

Returns:

The character set.