session
setCookie
Description
Manually set a cookie in the current session state.
sendDataToClient
Description
scrapeFile
Description
Manually scrape a scrapeable file.
Parameters
- scrapeableFileIdentifier Name of the scrapeable file, as a string.
Return Values
Returns void. If there is a problem accessing the scrapeable file an message will be written to the log.
setVariable
Description
Set the value of a session variable.
setRetainNonTidiedHTML
Description
Set whether or not non-tidied HTML is to be retained for all scrapeable files.
logCurrentTime
Description
Write current time to log (at most verbose level). The time is formatted to be human readable.
Parameters
This method does not receive any parameters.
Return Values
Returns void. If an error occurs, an error will be thrown.
logElapsedRunningTime
Description
Write scrape run time to the log (at most verbose level). It is formatted to be human readable, including breaking it into days, hours, minutes, and seconds.
Parameters
This method does not receive any parameters.
Return Values
Returns void. If an error occurs, an error will be thrown.
logCurrentDateAndTime
Description
Write current date and time to log (at most verbose level). It is formatted to be human readable.
Parameters
This method does not receive any parameters.
Return Values
Returns void. If an error occurs, an error will be thrown.
log
Description
Write message to the log.
Parameters
- message Message to be written to the log after being converted to a String using String.valueOf( message ).
Return Values
Returns void.