com.screenscraper.scraper

Class SOAPInterface

java.lang.Object

com.screenscraper.scraper.SOAPInterface

public class SOAPInterface
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAILURE
static java.lang.String[]	FAILURE_ARRAY
static java.lang.String[][]	FAILURE_ARRAY_2D
static java.lang.String	FAILURE_STRING
static org.apache.log4j.Logger	log Used for logging.
static int	SUCCESS

Constructor Summary

Constructors

Constructor and Description
SOAPInterface() Constructs the SOAP Inteface.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCompletedScrapingSessions() Returns the ID's of the completed scraping sessions.
java.lang.String[]	getDataRecord(java.lang.String id, java.lang.String var) Get a data record for the given variable.
java.lang.String[][]	getDataSet(java.lang.String id, java.lang.String var) Get the data set contained in a variable in a scraping session.
java.lang.String	getLog(java.lang.String filename) Return the content of a given log file.
java.lang.String	getLog(java.lang.String filename, boolean start, int lines) Returns a portion of the content of a given log file.
java.lang.String[]	getLogNames() Returns the names of all the files in the log directory of the remote server.
long	getLogSize(java.lang.String filename) Return the size of the given logfile in bytes.
java.lang.String[]	getRunningScrapingSessions() Return the ID's of the currently running scraping sessions.
java.lang.String	getScrapingSessionName(java.lang.String id) Returns the name of the scraping session with key=id.
java.lang.String[]	getScrapingSessionNames() Returns an array of names of scraping sessions which this server currently has.
long	getScrapingSessionStartTime(java.lang.String id) Returns the starting time of a particular scraping session as a long.
java.lang.String[]	getScriptNames() Returns the names of scripts in this server.
java.lang.String	getVariable(java.lang.String id, java.lang.String var) Get the value of a certain variable in a scraping session.
java.lang.String	initializeScrapingSession(java.lang.String name) Initialize this scraping session to allow it to be scraped.
static boolean	isAcceptingConnections() Returns the value to acceptingConnections, which is the value which dictates if the server is handling remote requests to scrape.
int	isFinished(java.lang.String id) Returns if the session with key=id is finished.
int	removeCompletedScrapingSession(java.lang.String id) Remove the scraping session given by id from the list of completed scraping sessions.
int	removeLog(java.lang.String filename) Remove a log file from the log directory on the remote server.
int	removeScrapingSession(java.lang.String name) Remove a scraping session from the remote server and from it's database.
int	removeScript(java.lang.String name) Remove a script from the remote server and it's database.
int	scrape(java.lang.String id) Scrape the session given by this ID.
static int	setAcceptingConnections(boolean accepting) Sets the value for acceptingConnections, which will either stop the server from handling requests for remote scrapes or allow them.
int	setTimeout(java.lang.String id, int minutes) Set the time out minutes of a scraping session to scrape.
int	setVariable(java.lang.String id, java.lang.String var, java.lang.String value) Set a variable within a scraping session.
int	stopScrapingSession(java.lang.String id) Stop a scraping session in progress.
int	update(java.lang.String xml) Update the remote server with an exported scraping session or script.

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.

SUCCESS

public static int SUCCESS

FAILURE

public static int FAILURE

FAILURE_STRING

@NotNull
public static java.lang.String FAILURE_STRING

FAILURE_ARRAY

@NotNull
public static java.lang.String[] FAILURE_ARRAY

FAILURE_ARRAY_2D

@NotNull
public static java.lang.String[][] FAILURE_ARRAY_2D

Constructor Detail

SOAPInterface

public SOAPInterface()

Constructs the SOAP Inteface.

Method Detail

isAcceptingConnections

public static boolean isAcceptingConnections()

Returns the value to acceptingConnections, which is the value which dictates if the server is handling remote requests to scrape.

Returns:

true if the server is will accept requests to scrape.

setAcceptingConnections

public static int setAcceptingConnections(boolean accepting)

Sets the value for acceptingConnections, which will either stop the server from handling requests for remote scrapes or allow them.

Parameters:

accepting - value to change acceptingConnections to.

Returns:

int which represents success or a specific error code.

getScrapingSessionNames

@NotNull
public java.lang.String[] getScrapingSessionNames()

Returns an array of names of scraping sessions which this server currently has.

Returns:

names of scraping sessions.

getScriptNames

@NotNull
public java.lang.String[] getScriptNames()

Returns the names of scripts in this server.

Returns:

names of scripts.

getRunningScrapingSessions

@NotNull
public java.lang.String[] getRunningScrapingSessions()

Return the ID's of the currently running scraping sessions.

Returns:

An array of Strings, which are the ID's.

getCompletedScrapingSessions

@NotNull
public java.lang.String[] getCompletedScrapingSessions()

Returns the ID's of the completed scraping sessions. (Also, updates the list.)

Returns:

the ID's of completed scraping sessions.

removeCompletedScrapingSession

public int removeCompletedScrapingSession(@NotNull
                                          java.lang.String id)

Remove the scraping session given by id from the list of completed scraping sessions.

Parameters:

id - the ID of the scraping session to be removed.

Returns:

an int representing success or a failure code.

isFinished

public int isFinished(@NotNull
                      java.lang.String id)

Returns if the session with key=id is finished.

Parameters:

id - the ID of the scraping session to check status.

Returns:

an int representing finished (1), not finished (0) or error (0)

getScrapingSessionName

@Nullable
public java.lang.String getScrapingSessionName(@NotNull
                                                          java.lang.String id)

Returns the name of the scraping session with key=id.

Parameters:

id - the ID of a scraping session.

Returns:

the name of a scraping session, or "-1" if not found.

getScrapingSessionStartTime

public long getScrapingSessionStartTime(@NotNull
                                        java.lang.String id)

Returns the starting time of a particular scraping session as a long.

Parameters:

id - the ID of a scraping session.

Returns:

the starting time of the scraping session, -1 if not yet started, or 0 if session not found.

initializeScrapingSession

@NotNull
public java.lang.String initializeScrapingSession(java.lang.String name)

Initialize this scraping session to allow it to be scraped.

Parameters:

name - the name of the scraping session to initialize.

Returns:

if success then the ID of this scraping session is returned, otherwise "-1".

scrape

public int scrape(@NotNull
                  java.lang.String id)

Scrape the session given by this ID.

Parameters:

id - the ID of a scraping session.

Returns:

0 if an error occurred or 1 if successfully started.

setVariable

public int setVariable(@NotNull
                       java.lang.String id,
                       @NotNull
                       java.lang.String var,
                       java.lang.String value)

Set a variable within a scraping session. Disallowed if acceptingConnections is false.

Parameters:

id - the ID of a scraping session that has been initialized.

var - the name of the variable to set.

value - the value to set the variable to.

Returns:

1 if successfully set, 0 otherwise.

setTimeout

public int setTimeout(@NotNull
                      java.lang.String id,
                      int minutes)

Set the time out minutes of a scraping session to scrape.

Parameters:

id - the ID of a scraping session.

minutes - the number of minutes before this session will timeout.

Returns:

1 if successful, 0 otherwise.

stopScrapingSession

public int stopScrapingSession(@NotNull
                               java.lang.String id)

Stop a scraping session in progress.

Parameters:

id - the ID of a scraping session.

Returns:

1 if successful, 0 otherwise.

getVariable

@Nullable
public java.lang.String getVariable(@NotNull
                                               java.lang.String id,
                                               @NotNull
                                               java.lang.String var)

Get the value of a certain variable in a scraping session.

Parameters:

id - the ID of a scraping session.

var - the name of the variable to get the value of.

Returns:

if this is a valid scraping session and the value of this variable is a string, then the value is returned, "NULL" if the value is null, and "-1" otherwise.

getDataRecord

@NotNull
public java.lang.String[] getDataRecord(@NotNull
                                                  java.lang.String id,
                                                  @NotNull
                                                  java.lang.String var)

Get a data record for the given variable.

Parameters:

id - the ID of a scraping session.

var - the name of a variable in this scraping session.

Returns:

an array of Strings like "key=value" or an empty array if an error happened or the variable is empty.

getDataSet

@NotNull
public java.lang.String[][] getDataSet(@NotNull
                                                 java.lang.String id,
                                                 @NotNull
                                                 java.lang.String var)

Get the data set contained in a variable in a scraping session.

Parameters:

id - the ID of a scraping session.

var - the name of a variable.

Returns:

an array of data records as translated to arrays of Strings.

update

public int update(@NotNull
                  java.lang.String xml)

Update the remote server with an exported scraping session or script.

Parameters:

xml - the XML contained within an exported scraping session file.

Returns:

0 for failure, 1 for success.

removeScrapingSession

public int removeScrapingSession(java.lang.String name)

Remove a scraping session from the remote server and from it's database.

Parameters:

name - the name of the scraping session to be removed.

Returns:

0 for failure, 1 for success.

removeScript

public int removeScript(java.lang.String name)

Remove a script from the remote server and it's database.

Parameters:

name - the name of a script to e removed.

Returns:

0 for failure, 1 for success.

getLogNames

@Nullable
public java.lang.String[] getLogNames()

Returns the names of all the files in the log directory of the remote server.

Returns:

an array of the names of the log files, or null if there is no log directory.

getLogSize

public long getLogSize(java.lang.String filename)

Return the size of the given logfile in bytes.

Parameters:

filename - the name of a file in the log directory.

Returns:

a long representing the length in bytes of this file, or 0 if the file does not exist or is empty.

getLog

@Nullable
public java.lang.String getLog(java.lang.String filename)

Return the content of a given log file.

Parameters:

filename - the name of the file to get the contents of.

Returns:

a String of the contents of the file, or "" if not possible.

getLog

@Nullable
public java.lang.String getLog(java.lang.String filename,
                                          boolean start,
                                          int lines)

Returns a portion of the content of a given log file.

Parameters:

filename - the name of a log file.

start - true to return content from the beginning of a file, false to start counting lines from the end.

lines - the number of lines from the log file to return.

Returns:

a portion of the content of the given log file, or "" if anything goes wrong.

removeLog

public int removeLog(java.lang.String filename)

Remove a log file from the log directory on the remote server.

Parameters:

filename - the name of the file to remove.

Returns:

0 for failure, 1 for success.