ScrapingSession

java.lang.Object
- com.screenscraper.scraper.ScrapingSession

All Implemented Interfaces:: Deleteable, Folderable, RunningScrapingSession, ScriptInstancesContainer, java.awt.datatransfer.Transferable, java.lang.Comparable

public final class ScrapingSession
extends java.lang.Object
implements ScriptInstancesContainer, Deleteable, RunningScrapingSession, java.lang.Comparable, java.awt.datatransfer.Transferable, Folderable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class ScrapingSession.BreakpointFrameDisposer

(package private) class ScrapingSession.BreakpointFrameLauncher

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`ScrapingSession.BreakpointFrameDisposer`
`(package private) class`	`ScrapingSession.BreakpointFrameLauncher`

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static java.awt.datatransfer.DataFlavor[]`	`flavors`
`static java.awt.datatransfer.DataFlavor`	`INFO_FLAVOR` Drag 'n drop stuff.
`static int`	`INT_ACCEPT`
`static int`	`INT_APACHE_HTTPCLIENT`
`static int`	`INT_ASYNC_HTTPCLIENT_2`
`static int`	`INT_BEST_MATCH`
`static int`	`INT_CURL_HTTPCLIENT`
`static int`	`INT_HTTP_CLIENT_HTTPCLIENT`
`static int`	`INT_HTTP_CLIENT_IE`
`static int`	`INT_HTTP_CLIENT_MOZILLA`
`static int`	`INT_NING_ASYNC_HTTPCLIENT`
`static int`	`INT_REJECT`
`static int`	`INT_STRICT_MODE`
`static org.apache.log4j.Logger`	`log` Used for logging.
`static java.lang.String`	`STRING_ACCEPT`
`static java.lang.String`	`STRING_ACCORDING_TO_COOKIE_SPEC` Cookie policy constants.
`static java.lang.String`	`STRING_APACHE_HTTPCLIENT` Constants used to determine the client to use for the session.
`static java.lang.String`	`STRING_ASYNC_HTTPCLIENT_2`
`static java.lang.String`	`STRING_BEST_MATCH`
`static java.lang.String`	`STRING_COMPATIBILITY`
`static java.lang.String`	`STRING_CURL_HTTPCLIENT`
`static java.lang.String`	`STRING_HTTP_CLIENT_HTTPCLIENT`
`static java.lang.String`	`STRING_HTTP_CLIENT_IE`
`static java.lang.String`	`STRING_HTTP_CLIENT_MOZILLA`
`static java.lang.String`	`STRING_NETSCAPE_DRAFT`
`static java.lang.String`	`STRING_NING_ASYNC_HTTPCLIENT`
`static java.lang.String`	`STRING_REJECT`
`static java.lang.String`	`STRING_STRICT_MODE`

Constructor Summary

Constructors
Constructor and Description
`ScrapingSession()` Needed by castor.
ScrapingSession(int scrapingSessionID, java.lang.String name, int cookieHandling, int cookiePolicy, int httpClientType, int maxHTTPRequests, java.lang.String externalProxyUsername, java.lang.String externalProxyPassword, java.lang.String externalProxyHost, java.lang.String externalProxyPort, java.lang.String externalNTProxyUsername, java.lang.String externalNTProxyPassword, java.lang.String externalNTProxyHost, java.lang.String externalNTProxyPort, boolean useStrictMode, int folderID, java.lang.String notes, boolean anonymize, boolean terminateProxiesOnCompletion, int numberOfRequiredProxies, int originatorEdition, int loggingLevel, java.lang.String characterSet, java.lang.String keyStoreFilePath, java.lang.String keyStorePassword, boolean useOnlySSLv3, java.lang.String createdByVersion, long dateUpdated) Generates a new ScrapingSession with all of its basic information.
`ScrapingSession(ScrapingSession scrapingSession)` Generates a new scraping session as a copy of the given one.
`ScrapingSession(java.lang.String name)` Generates a new ScrapingSession, given a string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllExecuteScriptScriptsToExport()` Adds all execute script scripts that need to be exported by examining each script invoked from within this scraping session for invocations of session.executeScript.
`void`	`addAutoProgressBar(java.lang.String name, java.util.Collection<java.lang.String> values)` Creates an automatic progress bar and adds it to the progress bars.
`void`	`addAutoProgressBar(java.lang.String name, DataSet values, java.lang.String key)` Creates an automatic progress bar and adds it to the progress bars.
`void`	`addAutoProgressBar(java.lang.String name, java.lang.String... values)` Creates an automatic progress bar and adds it to the progress bars.
`void`	`addAutoProgressBar(java.lang.String name, java.lang.String[][] values)` Creates an automatic progress bar and adds it to the progress bars.
`void`	`addAutoProgressBar(java.lang.String name, java.lang.String[][] values, int keyIndex)` Creates an automatic progress bar and adds it to the progress bars.
`protected void`	`addChildScrapingSession(ScrapingSession childScrapingSession)` Adds a child ScrapingSession object.
`<T extends AbstractEventData> void`	`addEventCallback(EventFireTime<T> eventTime, EventHandler<T> callback)` Add a runnable that will be executed at the given time.
`<T extends AbstractEventData> void`	`addEventCallbackWithPriority(EventFireTime<T> eventTime, EventHandler<T> callback, int priority)` Add a runnable that will be executed at the given time and priority.
`void`	`addExecuteScriptScriptToExport(Script script)` Adds a script to be exported that gets invoked via session.executeScript.
`void`	`addMonitoredPostfix(java.lang.String postfix)` Watches for all session variables whose keys end with the postfix specified, and will output their values when monitored variables are logged.
`void`	`addMonitoredPrefix(java.lang.String prefix)` Watches for all session variables whose keys begin with the prefix specified, and will output their values when monitored variables are logged.
`java.lang.Object`	`addMonitoredValue(java.lang.String name, java.lang.Object value)` Adds a specific name and value to be logged with the web messages methods or logMonitoredValues method
`void`	`addMonitoredVariable(java.lang.String key)` Watches the value of a session variable, and will output it each time monitored variables are output
`ProgressBar`	`addProgressBar(java.lang.String title)` Adds a new progress bar with the given title
`ProgressBar`	`addProgressBar(java.lang.String title, double total)` Adds a new progress bar with the given title and total
`ProgressBar`	`addProgressBar(java.lang.String title, java.lang.String total)` Adds a new progress bar with the given title and total
`void`	`addRandomDelayBetweenRequests(long minMs, long maxMs)` Adds a random delay between requests, ranging from the min to max number of milliseconds.
`void`	`addScrapeableFile(ScrapeableFile scrapeableFile)` Inserts a ScrapeableFile into the session.
`void`	`addSessionVariableMonitor(java.lang.String monitoredVariable)` Deprecated.
`void`	`addToNumDuplicateRecordsScraped(int numRecordsScraped)` Adds to the number of duplicate records scraped.
`void`	`addToNumErrorRecordsScraped(int numRecordsScraped)` Adds to the number of error records scraped.
`void`	`addToNumNewRecordsScraped(int numRecordsScraped)` Adds to the number of new records scraped.
`void`	`addToNumRecordsScraped(int numRecordsScraped)` Adds to the number of records scraped.
`void`	`addToNumRecordsScraped(java.lang.Object numRecordsScraped)` Adds to the number of records scraped.
`void`	`addToNumUpdatedRecordsScraped(int numRecordsScraped)` Adds to the number of updated records scraped.
`void`	`addToVariable(java.lang.String variable, int value)` Adds a value to a session variable.
`void`	`addXMLFeedItem(java.lang.String title, java.lang.String link, java.lang.String description, java.util.Date publishedDate)` Adds an XML feed entry to the session.
`void`	`appendErrorMessage(java.lang.String errorMessage)` Adds a message to the existing error message(s).
`void`	`appendStatusMessage(java.lang.String statusMessage)` Adds a message to the existing status message(s).
`void`	`breakpoint()` Performs a breakpoint.
`void`	`breakpoint(boolean logVariablesInNonWorkbench)` Pauses the scrape and opens the breakpoint window.
`void`	`breakpoint(java.lang.Object message)` Pauses the scrape and opens the breakpoint window.
`void`	`breakpoint(java.lang.Object message, boolean logVariablesInNonWorkbench)` Pauses the scrape and opens the breakpoint window.
`void`	`breakpoint(ScriptContext scriptContext)` Performs a breakpoint.
`void`	`breakpointIfNeeded()` Breakpoints, if needed.
`void`	`bumpScrapeableFileSequences(int minimumSequence, int maximumSequence, boolean bumpUp)` Bumps the sequence up or down by one for any `ScrapeableFile` whose sequence falls in between the given sequences.
`java.io.File`	`cacheBytes(java.lang.String outputFilenameAndPath, byte[] bytes)` Adds a file to the cache from bytes.
`java.io.File`	`cacheFile(java.lang.String outputFilenameAndPath, java.io.File fileToCache)` Adds a file to the cache.
`java.io.File`	`cacheScrapeableFile(ScrapeableFile scrapeableFile)` Caches the HTML and headers of the scrapeable file
`java.io.File`	`cacheText(java.lang.String name, java.lang.String content)` Adds text to the cache.
`java.io.File`	`cacheText(java.lang.String name, java.lang.String content, java.lang.String encoding)` Adds text to the cache.
`void`	`clearAllSessionVariables()` Clears all session variables.
`<T extends AbstractEventData> void`	`clearCallbacksForTime(EventFireTime<T> eventTime)` Clears the callbacks for the specified time
`void`	`clearCookies()` Clears all cookies.
`void`	`clearCustomScriptVariables()` Clears the custom script variables for this scraping session
`void`	`clearLastRequestsAndResponses()` Clears the last request and response for each of the constituent scrapeable files.
`void`	`clearProxySettings()`
`void`	`clearVariables(java.util.Collection<java.lang.Object> variables)` Clears the value of all session variables that that match the values in the collection
`void`	`clearVariables(java.util.Map<java.lang.Object,java.lang.Object> variables)` Clears the value of all session variables that that match the keys in the Map
`int`	`compareTo(java.lang.Object object)` Required by the `Comparable` interface.
`void`	`convertHTMLEntitiesInVariable(java.lang.String variable)` Replaces HTML entities in a variable with their non-entity equivalents.
`void`	`currentProxyServerIsBad()` Removes the current `ProxyServer` from the pool.
`void`	`debug(java.lang.Object message)` Sends an app event off to the view to be logged as DEBUG.
`void`	`debug(java.lang.Object message, java.lang.Throwable throwable)` Sends an app event off to the view to be logged as DEBUG.
`void`	`delete()` Deletes the session from the database.
`void`	`determineUsesNavigationActions()` Determines and sets whether or not this scraping session uses navigation actions.
`void`	`doExtendedReset(boolean nullScrapingSessionNotifiables)` Resets any remaining objects, which external entities querying the scraping session for data may otherwise rely on.
`boolean`	`doLazyScrape()` Indicates whether or not the session should do a "lazy" scrape.
`boolean`	`downloadFile(java.lang.String urlString, java.lang.String fileName)` A utility method for downloading a resource and writing it to a file.
`boolean`	`downloadFile(java.lang.String urlString, java.lang.String fileName, int maxNumAttempts)` A utility method for downloading a resource and writing it to a file.
`boolean`	`downloadFile(java.lang.String urlString, java.lang.String fileName, int maxNumAttempts, boolean doLazy)` A utility method for downloading a resource and writing it to a file.
`void`	`dumpToLog()` Dumps the session to the log.
`void`	`enableCaching(java.lang.String description, boolean saveLogs, boolean zipCachedFiles)` Enables caching for this scrape.
`java.io.File`	`endCaching()` Ends the cache for the scrape.
`void`	`endCachingAtScrapeClose()` Ends the cache for the scrape.
`void`	`ensureFullyLoaded()` Ensures that the scraping session is completely loaded.
`void`	`ensureScrapeableFilesHaveScrapingSessionReference()` Ensures that all constituent scrapeable file objects have a reference to this scraping session.
`boolean`	`equals(java.lang.Object object)` Overriding equals...
`void`	`error(java.lang.Object message)` Sends an app event off to the view to be logged as ERROR.
`void`	`error(java.lang.Object message, java.lang.Throwable throwable)` Sends an app event off to the view to be logged as ERROR.
`void`	`executeScript(java.lang.String scriptName)` Executes the named script.
`void`	`executeScriptWithContext(java.lang.String scriptName)` Executes the named script, but preserves the current context (dataRecord, scrapeableFile, etc...)
`void`	`export(java.io.OutputStream outputStream)` Exports the scraping session to the given stream.
`protected void`	`finalize()`
`void`	`flagAsLoaded()` Flags the scraping session as having been loaded.
`void`	`generateScrapeableSession()` Generates a scrapeable session that will correspond to a running instance of this scraping session.
`java.util.Map<java.lang.String,java.lang.Object>`	`getAllInternalVariables()` Returns a duplicate of the session internal variables.
`protected java.lang.String`	`getAllSessionVariablesAsURLEncodedString()` Gets all session variables as a URL-encoded string.
`java.util.Map<java.lang.String,java.lang.Object>`	`getAllVariables()` Returns a duplicate of the session variables.
`boolean`	`getAnonymize()` Indicates whether or not the scrape should be anonymized
`boolean`	`getCachingEnabled()` Returns whether or not the cache is enabled for the scrape
`java.lang.String`	`getCharacterSet()` Gets the current character set being used.
`static java.lang.String`	`getCharacterSetFromScrapingSessionExportFile(java.io.File file)` Determines the character set of the scraping session by examining the contents of its export file.
`static java.lang.String`	`getCharacterSetFromScrapingSessionExportFile(java.io.File file, java.lang.String charSet)` Determines the character set of the scraping session by examining the contents of its export file.
`int`	`getConnectionTimeout()` Gets the connection timeout to use.
`java.util.List<ScrapingCookie>`	`getCookieList()` Returns a list of cookies for the current session
`int`	`getCookiePolicy()` Gets the cookie policy option.
`java.lang.String`	`getCookiePolicyAsHttpClientString()` Gets the cookie policy as a `String` that is friendly to HttpClient 4.
`org.apache.commons.httpclient.Cookie[]`	`getCookies()` Deprecated. Use the `getCookieList()` method instead.
`java.lang.String`	`getCreatedByVersion()` Gets the version of ss that originally created the scraping session.
`ProxyServer`	`getCurrentProxyServerFromPool()` Gets a reference to the current `ProxyServer` being used from the pool.
`ScriptContext`	`getCurrentScriptContext()` Gets the current `ScriptContext`.
`java.lang.String[]`	`getCurrentStack()` Returns the current stack of scripts
`java.lang.Object`	`getCustomScriptVariable(java.lang.String name)` Returns the current value for the given custom script variable
`java.util.Map<java.lang.String,java.lang.Object>`	`getCustomScriptVariables()` Returns a map of the current script variables.
`java.lang.Object[]`	`getDataToSendToClientAsArrayAndFlush()` Gets the data to be sent to the client as a raw array of `HashMap` objects, then flushes out all of the data from the array list.
`java.lang.String`	`getDateExported()` Gets the date the scraping session was exported.
`long`	`getDateUpdated()` Gets the last time the scraping session was updated.
`boolean`	`getDebugMode()` Checks to see if this is currently set to run in debug mode
`RetryPolicy`	`getDefaultRetryPolicy()` Gets the default retry policy to be used by each scrapeable file when one wasn't set for it.
`java.lang.String`	`getDefaultUserAgent()` Gets the default user agent.
`long`	`getElapsedRunningTime()` Gets the number of milliseconds that have passed since the scraping session started.
`java.lang.String`	`getErrorMessage()` Gets the error message that should be persisted to the database once the scraping session ends.
`EventEngine`	`getEventEngine()` Returns the event engine used to add custom event callbacks
`EventEngine`	`getEventEngineInternal()` Returns the event engine used to add custom event callbacks.
`java.util.HashSet`	`getExecuteScriptScriptsToExport()` Gets the set that holds scripts that need to be exported that are called via session.executeScript.
`java.lang.String`	`getExternalNTProxyDomain()` Gets the external NT proxy port.
`java.lang.String`	`getExternalNTProxyHost()` Gets the external NT proxy host.
`java.lang.String`	`getExternalNTProxyPassword()` Gets the external NT proxy password.
`java.lang.String`	`getExternalNTProxyUsername()` Gets the NT external proxy username.
`java.lang.String`	`getExternalProxyHost()` Gets the external proxy host.
`java.lang.String`	`getExternalProxyPassword()` Gets the external proxy password.
`java.lang.String`	`getExternalProxyPort()` Gets the external proxy port.
`java.lang.String`	`getExternalProxyUsername()` Gets the external proxy username.
`boolean`	`getFatalErrorOccurred()` Gets the flag used to indicate whether or not a fatal error occurred while running this scraping session.
`Folder`	`getFolder()` Gets the folder containing this object.
`boolean`	`getHasBeenQueued()` Indicates whether or not the scraping session has been queued to be run.
`ScrapingHttpClient`	`getHttpClient()` Gets the HTTP client to be used in scraping.
`int`	`getHTTPClientType()` Gets the HTTP client to be used throughout the session.
`int`	`getID()` Gets the ID of the scraping session.
`java.lang.String`	`getIdentifier()`
`int`	`getImageHeight(java.lang.String imagePath)` Gets the height of an image.
`int`	`getImageWidth(java.lang.String imagePath)` Gets the width of an image.
`<T> T`	`getInternalVariable(java.lang.String key)` Gets the value of an internal variable.
`java.lang.String`	`getKeyStoreFilePath()` Gets the path to the keystore file.
`java.lang.String`	`getKeyStorePassword()` Gets the password to be used for the key store file.
`java.lang.String`	`getLastDeterminedCharacterSet()` Gets the last character set determined from a server.
`java.util.Date`	`getLastImportTime()` In workbench mode returns the current time, otherwise returns the last time a scrape with this name was imported (or if it hasn't been imported since the instance was started will return the instance start time)
`ProgressBar`	`getLastProgressBar()` Returns the last progress bar
`ScrapeableFile`	`getLatestActiveScrapeableFile()` Gets the scrapeable file most recently added to the active scrapeable files.
`java.lang.String`	`getLogFileName()` Gets the name of the log file corresponding to this scraping session.
`int`	`getLoggingLevel()` Gets the logging level to use when running the scraping session.
`int`	`getMaxConcurrentFileDownloads()` Gets the maximum number of concurrent file downloads to a allow.
`int`	`getMaxHTTPRequests()` Gets the maximum number of attempts that should be made for each HTTP request.
`int`	`getMaxScriptsOnStack()` Gets the maximum number of script context objects that can be pushed on to the stack.
`int`	`getMemoryUsage()` Gets the average memory usage.
`java.lang.String`	`getName()` Gets the name.
`java.lang.String`	`getNameUpperCase()` Gets the name in upper case (used for comparing with other scraping sessions).
`boolean`	`getNeedsToBeSaved()` Indicates whether or not the object needs to be saved.
`java.lang.String`	`getNextDefaultScrapeableFileName()` Gets the name of a new scrapeable file, ensuring it isn't a duplicate.
`javax.swing.tree.DefaultMutableTreeNode`	`getNode()` Gets the node representing this session.
`ScrapeableFile`	`getNonSequencedScrapeableFileBySequence(int sequence)` Gets a scrapeable file from the session that doesn't have a sequence, but is found by cycling through the scrapeable files alphabetically.
`java.lang.String`	`getNotes()` Gets the notes.
`boolean`	`getNotifyNotifiableOfCompletion()` Indicates whether or not the notifiable object should be notified once the scraping session completes.
`int`	`getNumActiveScrapeableFiles()` Gets the number of active scrapeable files.
`int`	`getNumberOfRequiredProxies()` The number of proxies required to anonymize this scraping session
`int`	`getNumDuplicateRecordsScraped()` Gets the number of duplicate records scraped for the primary data set corresponding to this scraping session.
`int`	`getNumErrorRecordsScraped()` Gets the number of error records scraped for the primary data set corresponding to this scraping session.
`int`	`getNumNewRecordsScraped()` Gets the number of new records scraped for the primary data set corresponding to this scraping session.
`int`	`getNumProgressBars()` Returns the current number of progress bars
`int`	`getNumRecordsScraped()` Gets the number of records scraped for the primary data set corresponding to this scraping session.
`int`	`getNumScrapeableFiles()` Returns the number of scrapeable files currently held by the session.
`int`	`getNumScrapeableFilesWithSequence()` Returns the number of scrapeable files currently held by the session that use a valid sequence.
`int`	`getNumScriptsOnStack()` Gets the number of `ScriptContext` objects on the stack.
`int`	`getNumUpdatedRecordsScraped()` Gets the number of duplicate records scraped for the primary data set corresponding to this scraping session.
`int`	`getOriginatorEdition()` Indicates the edition of screen-scraper in which the scraping session was created.
`ScrapingSession`	`getParentScrapingSession()` If this scraping session was invoked as a RunnableScrapingSession this gets its parent.
`ProgressBar`	`getProgressBar(int index)` Returns the progress bar at the given index, with 0 being the highest level bar, and lower-level bars being sequentially larger in index
`ProgressBar`	`getProgressBar(java.lang.String title)` Returns the first progress bar with the given title, or null if none is found.
`ProxyServerPool`	`getProxyServerPool()` Gets the current `ProxyServerPool` object, used to cycle through a pool of proxies.
`boolean`	`getRandomizeUserAgent()` Indicates whether or not the user agent should be randomized.
`int`	`getRelativeRecordsScrapedThreshold()` Gets the records scraped threshold to use for the scraping session.
`int`	`getRelativeTimeThreshold()` Gets the time threshold to use for the scraping session.
`boolean`	`getRetainNonTidiedHTML()` Gets whether or not the tidied HTML should be retained for all of the scrapeable files in this session.
`ScrapeableFile`	`getScrapeableFile(int sequence)` Gets a scrapeable file from the session.
`ScrapeableFile`	`getScrapeableFile(java.lang.String name)` Gets a scrapeable file from the session.
`ScrapeableFile`	`getScrapeableFileByID(int scrapeableFileID)` Gets a scrapeable file from the session by its ID.
`ScrapeableFile`	`getScrapeableFileCaseInsensitive(java.lang.String name)` Gets a scrapeable file from the session, without regard to case.
`java.util.HashSet`	`getScrapeableFiles()` Gets all `ScrapeableFile`s associated with this scraping session.
`java.util.Iterator`	`getScrapeableFilesIterator()` An `Iterator` used to cycle through the `ScrapeableFile` objects held by this object.
`ScrapeableSession`	`getScrapeableSession()` Gets the scrapeable session that corresponds to a running instance of this scraping session.
`int`	`getScrapeableSessionID()` When running, this will get the scrapeable session ID.
`FileCacher`	`getScrapeCache()` Returns the scrape cacher object used to cache data about the scrape
`ScrapeStateLogger`	`getScrapeLogger()` Gets the ScrapeStateLogger that is currently holding monitored variable names, etc...
`ScrapingSessionNotifiable`	`getScrapingSessionNotifiable()` Gets the object the scraping session will use to notify its progress of.
`ScrapingSessionState`	`getScrapingSessionState()` Gets the session state for scripts as scrapeable files are being processed.
`ScriptInstances`	`getScriptInstances()` Returns a `ScriptInstances` object containing all script instances associated with this scrapeable file.
`boolean`	`getShouldBreakpoint()` Gets whether or not the session should breakpoint at the next opportunity
`long`	`getStartTime()` Gets the starting time in milliseconds.
`java.lang.String`	`getStatusMessage()` Gets the status message that should be persisted to the database once the scraping session ends.
`StopScrapingCallType`	`getStopScrapingCallType()` Returns the call type that was issued to initially stop the scraping session
`java.lang.String`	`getStopScrapingExplanation()` Returns a string explaining the reason why the scrape was stopped initially.
`boolean`	`getStopScrapingOnExtractorPatternTimeout()` Gets whether or not scraping should stop in the event of an extractor pattern timeout
`boolean`	`getStopScrapingOnMaxRequestAttemptsReached()` Gets whether or not scraping should stop in the event of max request attempts reached.
`boolean`	`getStopScrapingOnScriptError()` Gets whether or not scraping should stop in the event of a script error.
`boolean`	`getTerminateProxiesOnCompletion()` Indicates whether or not proxies should be terminated on completion
`int`	`getTimeout()` Gets the timeout, in minutes, for the scraping session.
`java.util.TimeZone`	`getTimeZone()` Gets the current time zone of the Scraping Session
`java.lang.Object`	`getTransferData(java.awt.datatransfer.DataFlavor df)`
`java.awt.datatransfer.DataFlavor[]`	`getTransferDataFlavors()`
`java.net.URL`	`getURLToUseAsReferer()` Gets the URL that should be used for the referer HTTP header for scrapeable files subsequent to this one.
`FileCacher`	`getUsableScrapeCache()` Returns the scrape cacher object used to cache data about the scrape, or the parent scrapes if this scrape has a parent but not a cacher
`boolean`	`getUseOnlySSLv3()` Gets whether or not only SSLv3 should be used when connecting to remote servers.
`boolean`	`getUseProxyFromPool()` Indicates whether or not a proxy should be used for the current request(s).
`java.lang.String`	`getUserAgent()` Gets the user-agent to be used in HTTP requests.
`boolean`	`getUseServerCharacterSet()` Gets whether the character set indicated by the server should be used.
`boolean`	`getUsesNavigationActions()` Indicates whether or not any scrapeable files held by this scraping session use navigation actions.
`boolean`	`getUseStrictMode()` Indicates whether or not strict mode should be used.
`java.lang.Object`	`getv(java.lang.String variable)` Alias to getVariable.
`java.lang.Object`	`getVariable(java.lang.String variable)` Gets the value of a session variable.
`com.gargoylesoftware.htmlunit.WebClient`	`getWebClient()` Gets the HTMLUnit web client used in navigating.
`void`	`handleScriptError(ScriptException scriptException, ScriptContext scriptContext)` Handles reporting and responding to a script error.
`int`	`hashCode()`
`void`	`info(java.lang.Object message)` Sends an app event off to the view to be logged as INFO.
`void`	`info(java.lang.Object message, java.lang.Throwable throwable)` Sends an app event off to the view to be logged as INFO.
`boolean`	`isCompleted()` Indicates whether or not the scraper has finished scraping.
`boolean`	`isCreatedByVersionAtLeast(java.lang.String compareToVersion)` Indicates whether or not the version that created this scraping session is greater than or equal to the given version.
`boolean`	`isDataFlavorSupported(java.awt.datatransfer.DataFlavor df)` ************************************************** Transferable methods.
`boolean`	`isRunning()` Indicates whether or not the session is currently running.
`boolean`	`isRunningFromCommandLine()` Returns whether or not we are currently running from the command line.
`boolean`	`isRunningInServer()` Returns whether or not we are currently running in server mode.
`boolean`	`isRunningInWorkbench()` Returns whether or not we are currently running in the workbench.
`void`	`loadStateFromString(java.lang.String stateXML)` Loads the scrape state from an xml string, but doesn't clear whatever was there.
`void`	`loadVariables(java.lang.String fileToReadFrom)` Reads in and loads the session variables that were previously saved to a file.
`void`	`log(int message)` Sends an app event off to the view to be logged.
`void`	`log(java.lang.Object message)` Sends an app event off to the view to be logged.
`void`	`logCurrentDateAndTime()` Logs the current date and time.
`void`	`logCurrentTime()` Logs the current time.
`void`	`logDataRecord(DataRecord record)` Logs all the values in a Data Record to the log, with one line per value.
`void`	`logDataRecord(DataRecord record, int logLevel)` Logs all the values in a Data Record to the log, with one line per value.
`void`	`logDataRecordDebug(DataRecord record)` Logs a DataRecord at the Debug level
`void`	`logDataRecordError(DataRecord record)` Logs a DataRecord at the Error level
`void`	`logDataRecordInfo(DataRecord record)` Logs a DataRecord at the Info level
`void`	`logDataRecordWarn(DataRecord record)` Logs a DataRecord at the Warn level
`void`	`logDebug(java.lang.Object message)` Sends an app event off to the view to be logged as DEBUG.
`void`	`logDebug(java.lang.String message)` Sends an app event off to the view to be logged as DEBUG.
`void`	`logElapsedRunningTime()` Logs the number of days, hours, minutes, and seconds from the time the scraping session started.
`void`	`logError(java.lang.Object message)` Sends an app event off to the view to be logged as ERROR.
`void`	`logError(java.lang.Object message, java.lang.Throwable t)` Sends an app event off to the view to be logged as ERROR.
`void`	`logError(java.lang.String message)` Sends an app event off to the view to be logged as ERROR.
`void`	`logException(java.lang.Throwable exception)` Logs an Exception, with a full stack trace
`void`	`logInfo(java.lang.Object message)` Sends an app event off to the view to be logged as INFO.
`void`	`logInfo(java.lang.String message)` Sends an app event off to the view to be logged as INFO.
`void`	`logMemoryUsage()` Logs memory usage for variables and such.
`void`	`logMonitoredValues(java.lang.Object message)` Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top.
`void`	`logMonitoredValues(java.lang.Object message, int logLevel)` Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top.
`void`	`logMonitoredValuesClose(java.lang.Object message)` Logs closing values to indicate the scrape is complete and what values were when everything finished.
`void`	`logMonitoredValuesDebug(java.lang.Object message)` Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top.
`void`	`logMonitoredValuesError(java.lang.Object message)` Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top.
`void`	`logMonitoredValuesInfo(java.lang.Object message)` Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top.
`void`	`logMonitoredValuesWarn(java.lang.Object message)` Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top.
`void`	`logObjectByType(java.lang.Object object)` Logs the Object in a semi intelligent way.
`void`	`logObjectByType(java.lang.Object object, int logLevel)` Logs the Object in a semi intelligent way.
`void`	`logObjectByTypeDebug(java.lang.Object object)` Logs the Object in a semi intelligent way.
`void`	`logObjectByTypeError(java.lang.Object object)` Logs the Object in a semi intelligent way.
`void`	`logObjectByTypeInfo(java.lang.Object object)` Logs the Object in a semi intelligent way.
`void`	`logObjectByTypeWarn(java.lang.Object object)` Logs the Object in a semi intelligent way.
`void`	`logScreenScraperInformation()` Logs useful information about the current instance of Screen-Scraper, as well as the Java VM and the General Utility version being used.
`void`	`logVariables()` Outputs all session variables to the log.
`void`	`logVariables(ScriptContext scriptContext)` Outputs all session variables to the log.
`void`	`logWarn(java.lang.Object message)` Sends an app event off to the view to be logged as WARN.
`void`	`logWarn(java.lang.String message)` Sends an app event off to the view to be logged as WARN.
`static int`	`mapCookiePolicyHumanReadableStringToInt(java.lang.String cookiePolicy)` Maps a cookie policy string to an int.
`static java.lang.String`	`mapCookiePolicyIntToHumanReadableString(int cookiePolicy)` Maps a cookie policy int to a human-readable string.
`static java.lang.String`	`mapHTTPClientIntToString(int httpClient)` Maps an HTTP client int to a human-readable string.
`static int`	`mapHTTPClientTypeStringToInt(java.lang.String httpClientType)` Maps an HTTP client string to an int.
`void`	`markStopTime()` Marks and sets the point at which the session should stop, if a timeout exists.
`void`	`moveToNewFolder(Folder folder)` Moves the object to a new folder.
`void`	`pause(long time)` Indicates that the scraping session should pause for the given number of milliseconds.
`void`	`popScriptContext()` Pops the top `ScriptContext` object off the stack.
`void`	`prepareAnonymization()` If the scrape is set to be anonymized this will initialize all the required settings and launch the required number of proxy servers.
`protected void`	`processPostScrapingScripts()` Processes any scripts after files are to be scraped.
`protected void`	`processPreScrapingScripts()` Processes any scripts before files are to be scraped.
`void`	`pushScriptContext(ScriptContext scriptContext)` Pushes a `ScriptContext` object on to the stack.
`static boolean`	`readerPointsToImportableScrapingSession(java.io.Reader reader)` Indicates whether or not the given reader points to an importable scraping session.
`java.lang.String`	`reformatDate(java.lang.String date, java.lang.String dateFormatTo)` Reformats a date.
`java.lang.String`	`reformatDate(java.lang.String date, java.lang.String dateFormatFrom, java.lang.String dateFormatTo)` Reformats a date.
`protected void`	`removeChildScrapingSession(ScrapingSession childScrapingSession)` Removes a child ScrapingSession object.
`<T extends AbstractEventData> void`	`removeEventCallback(EventFireTime<T> eventTime, EventHandler<T> callback)` Remove a runnable that will be executed at the given time
`void`	`removeFromFolder()` Removes the object from its current folder.
`void`	`removeMonitoredPostfix(java.lang.String postfix)` Stops watching for a postfix in session variables
`void`	`removeMonitoredPrefix(java.lang.String prefix)` Stops watching for a prefix in session variables
`java.lang.Object`	`removeMonitoredValue(java.lang.String name)` Removes a specific name from the manually set values to be logged.
`void`	`removeMonitoredVariable(java.lang.String key)` Stops watching the specified variable
`void`	`removeProgressBar(ProgressBar progressBar)` Removes the specified progress bar
`void`	`removeScrapeableFile(int sequence)` Removes a scrapeable file from the session.
`void`	`removeScrapeableFile(java.lang.String name)` Removes a scrapeable file from the session.
`void`	`removeSessionVariablesInMap(java.util.Map<java.lang.Object,java.lang.Object> variables, boolean ignoreLowerCaseKeys)` Clears the value of all session variables that that match the keys in the Map
`void`	`replaceScrapeableFile(ScrapeableFile scrapeableFile)` Replaces an existing scrapeable file with the given scrapeable file carrying the same name.
`(package private) void`	`resetCallbacks()`
`void`	`resetContainsNullableTokens()` Causes the containsNullableTokens value for each extractor pattern associated with each scrapeable file to be reset.
`void`	`resetInitialValues()` Resets a series of values to ensure that the scraping session starts fresh.
`void`	`resetNumRecordsScraped()` Resets the number of records scraped to 0.
`boolean`	`resetOnCompletion()` Indicates whether or not the session should be reset once it completes.
`void`	`resetReferers()` Resets the referer for all scrapeable files to null.
`void`	`resetScrapingSessionState()` Resets the scraping session state.
`(package private) void`	`resetThreadGate()` Resets the state of the thread gate so it is ready for a new scrape to run
`void`	`resizeImageFixHeight(java.lang.String originalFile, java.lang.String thumbnailFile, int newHeightSize, boolean deleteOriginalFile)` Creates a thumbnail for an existing image.
`void`	`resizeImageFixWidth(java.lang.String originalFile, java.lang.String thumbnailFile, int newWidthSize, boolean deleteOriginalFile)` Creates a thumbnail for an existing image.
`void`	`resizeImageFixWidthAndHeight(java.lang.String originalFile, java.lang.String thumbnailFile, int newWidthSize, int newHeightSize, boolean deleteOriginalFile)` Creates a thumbnail for an existing image.
`void`	`restoreHTTPParametersAfterScraping()` Indicates that HTTP parameters should be restored after the scraping session finishes scraping.
`void`	`save()` Saves the scraping session to the database.
`java.lang.String`	`saveStateToString(boolean saveCookies, boolean saveVariables)` Saves the scrape state to an XML string
`java.lang.String`	`saveStateToString(boolean saveCookies, java.util.Collection<java.lang.String> saveVariables)` Saves the scrape state to an XML string
`void`	`saveVariables(java.lang.String fileToSaveTo)` Writes out the current session variables to a file.
`void`	`scrape()` Required by the RunnableScrapingSession interface.
`void`	`scrapeFile(ScrapeableFile scrapeableFile)` Scrapes a file.
`void`	`scrapeFile(java.lang.String scrapeableFileName)` Scrapes a file.
`void`	`scrapeString(ScrapeableFile scrapeableFile, java.lang.String content)` Scrapes a file using the given string for the last response instead of issuing a request
`void`	`scrapeString(java.lang.String scrapeableFileName, java.lang.String content)` Calls a scrapeable file using the given contents as the response rather than issuing a request
`void`	`sendDataToClient(java.lang.String key, java.lang.Object value)` Queues up an element of data to be sent to a client.
`void`	`sendMail(java.lang.String subject, java.lang.String body, java.lang.String recipients, java.lang.String attachments, java.lang.String headers)` Sends mail to a pre-specified SMTP server.
`boolean`	`sessionTimedOut()` Indicates whether or not the session timed out.
`void`	`setAnonymize(boolean anonymize)` Indicates whether or not the scrape should be anonymized
`void`	`setAutoCloseAfterScrapeEnds(java.io.Closeable closeable)` Sets the given closeable to be automatically closed once the session completes.
`void`	`setCharacterSet(java.lang.String characterSet)` Sets the character set to use.
`void`	`setConnectionTimeout(int connectionTimeout)` Sets the connection timeout to use.
`void`	`setCookie(ScrapingCookie cookie)` Allows a cookie to be set in the current session state.
`void`	`setCookie(java.lang.String domain, java.lang.String name, java.lang.String value)` Allows a cookie to be set in the current session state.
`void`	`setCookie(java.lang.String domain, java.lang.String name, java.lang.String value, java.lang.String path, java.util.Date expires, boolean secure)` Sets a cookie
`void`	`setCookiePolicy(int cookiePolicy)` Sets the cookie policy option.
`void`	`setCreatedByVersion(java.lang.String createdByVersion)` Sets the version of ss that originally created the scraping session.
`void`	`setCurrentScriptContext(ScriptContext currentScriptContext)` Sets the current `ScriptContext`.
`void`	`setCustomScriptVariable(java.lang.String name, java.lang.Object value)` Sets a custom script variable.
`void`	`setDateExported(java.lang.String date)` Sets the date the scraping session was exported.
`void`	`setDateUpdated(long dateUpdated)` Sets the last time the scraping session was updated.
`void`	`setDebugMode(boolean debugMode)` Sets the debug state for the scrape.
`void`	`setDefaultRetryPolicy(RetryPolicy retryPolicy)` Sets a retry policy that will affect all files in the scrape.
`void`	`setDefaultUserAgent(java.lang.String defaultUserAgent)` Sets the default user agent.
`void`	`setDoLazyScrape(boolean doLazyScrape)` Determines whether or not the session should do a "lazy" scrape.
`void`	`setErrorMessage(java.lang.String errorMessage)` Sets the error message that should be persisted to the database once the scraping session ends.
`void`	`setExternalNTProxyDomain(java.lang.String externalNTProxyDomain)` Sets the external NT proxy port.
`void`	`setExternalNTProxyHost(java.lang.String externalNTProxyHost)` Sets the external NT proxy host.
`void`	`setExternalNTProxyPassword(java.lang.String externalNTProxyPassword)` Sets the external NT proxy password.
`void`	`setExternalNTProxyUsername(java.lang.String externalNTProxyUsername)` Sets the external NT proxy username.
`void`	`setExternalProxyHost(java.lang.String externalProxyHost)` Sets the external proxy host.
`void`	`setExternalProxyPassword(java.lang.String externalProxyPassword)` Sets the external proxy password.
`void`	`setExternalProxyPort(java.lang.String externalProxyPort)` Sets the external proxy port.
`void`	`setExternalProxyUsername(java.lang.String externalProxyUsername)` Sets the external proxy username.
`void`	`setFatalErrorOccurred(boolean fatalErrorOccurred)` Sets the flag used to indicate whether or not a fatal error occurred while running this scraping session.
`void`	`setFinishLock(java.lang.Object finishLock)` Sets the object that should be used to notify external classes when the scraping session finishes.
`void`	`setFolder(Folder folder)` Sets the folder containing this object.
`void`	`setHasBeenQueued(boolean hasBeenQueued)` Sets whether or not the scraping session has been queued to be run.
`void`	`setHttpClient(ScrapingHttpClient httpClient)` Sets the HTTP client to be used in scraping.
`void`	`setHttpClient(ScrapingHttpClient httpClient, boolean clientWillBeClosedExternally)` Sets the HTTP client to be used in scraping.
`void`	`setHTTPClientType(int httpClientType)` Sets the HTTP client to be used throughout the session.
`void`	`setID(int scrapingSessionID)` Sets the ID of the scraping session.
`void`	`setIdentifier(java.lang.String identifier)`
`void`	`setInternalVariable(java.lang.String key, java.lang.Object value)` Sets the value of an internal variable.
`void`	`setIsCompleted(boolean isCompleted)` Sets whether or not the scraper has finished scraping.
`void`	`setIsRunning(boolean isRunning)` Sets whether or not the session is currently running.
`void`	`setKeyStoreFilePath(java.lang.String keyStoreFilePath)` Sets the path to the keystore file.
`void`	`setKeyStorePassword(java.lang.String keyStorePassword)` Sets the password to be used for the key store file.
`void`	`setLastDeterminedCharacterSet(java.lang.String characterSet)` Sets the last character set determined from a server.
`void`	`setLogFileNameAsSessionVariable()` Causes the scraping session to set a session variable corresponding to the name of its log file.
`void`	`setLoggingLevel(int loggingLevel)` Sets the logging level to use when running the scraping session.
`void`	`setLoggingLevel(java.lang.String loggingLevel)` Sets the logging level based on a string.
`void`	`setLoggingLevelDebug()` Convenience method to set logging level to debug
`void`	`setLoggingLevelError()` Convenience method to set logging level to error
`void`	`setLoggingLevelInfo()` Convenience method to set logging level to info
`void`	`setLoggingLevelWarn()` Convenience method to set logging level to warn
`void`	`setMaxConcurrentFileDownloads(int maxConcurrentFileDownloads)` Sets the maximum number of concurrent file downloads to a allow.
`void`	`setMaxHTTPRequests(int maxHTTPRequests)` Sets the maximum number of attempts that should be made for each HTTP request.
`void`	`setMaxScriptsOnStack(int maxScriptsOnStack)` Sets the maximum number of script context objects that can be pushed on to the stack.
`void`	`setName(java.lang.String name)` Sets the name.
`void`	`setNeedsToBeSaved(boolean needsToBeSaved)` Sets whether or not the object needs to be saved.
`void`	`setNode(javax.swing.tree.DefaultMutableTreeNode node)` Sets the node representing this session.
`void`	`setNotes(java.lang.String notes)` Sets the notes.
`void`	`setNotifyNotifiableOfCompletion(boolean notifyNotifiableOfCompletion)` Determines whether or not the notifiable object should be notified once the scraping session completes.
`void`	`setNumberOfRequiredProxies(int numberOfRequiredProxies)` The number of proxies required to anonymize this scraping session
`void`	`setNumDuplicateRecordsScraped(int numRecordsScraped)` Sets the number of duplicate records scraped.
`void`	`setNumErrorRecordsScraped(int numRecordsScraped)` Sets the number of error records scraped.
`void`	`setNumNewRecordsScraped(int numRecordsScraped)` Sets the number of new records scraped.
`void`	`setNumRecordsScraped(int numRecordsScraped)` Sets the number of records scraped for the primary data set corresponding to this scraping session.
`void`	`setNumRecordsScraped(int numRecordsScraped, boolean addToValue)` Sets the number of records scraped for the primary data set corresponding to this scraping session.
`void`	`setNumRecordsScraped(java.lang.Object numRecordsScraped)` Sets the number of records scraped for the primary data set corresponding to this scraping session.
`void`	`setNumRecordsScraped(java.lang.Object numRecordsScraped, boolean addToValue)` Sets the number of records scraped for the primary data set corresponding to this scraping session.
`void`	`setNumUpdatedRecordsScraped(int numRecordsScraped)` Sets the number of duplicate records scraped.
`void`	`setOriginatorEdition(int originatorEdition)` Sets the edition of screen-scraper in which the scraping session was created.
`protected void`	`setParentScrapingSession(ScrapingSession parentScrapingSession)` If this scraping session was invoked as a RunnableScrapingSession this sets its parent.
`void`	`setProxyServerPool(ProxyServerPool proxyServerPool)` Gets the current `ProxyServerPool` object, used to cycle through a pool of proxies.
`void`	`setRandomizeUserAgent(boolean randomizeUserAgent)` Sets whether or not the user agent should be randomized.
`void`	`setRelativeRecordsScrapedThreshold(int relativeRecordsScrapedThreshold)` Sets the records scraped threshold to use for the scraping session.
`void`	`setRelativeTimeThreshold(int relativeTimeThreshold)` Sets the time threshold to use for the scraping session.
`void`	`setResetOnCompletion(boolean resetOnCompletion)` Determines whether or not the session should be reset once it completes.
`void`	`setRetainNonTidiedHTML(boolean retainNonTidiedHTML)` Sets whether or not the tidied HTML should be retained for all of the scrapeable files in this session.
`void`	`setScrapeableFiles(java.util.HashSet scrapeableFiles)` Sets all scrapeable files.
`(package private) void`	`setScrapeCacher(FileCacher cacher)` Sets the cacher that will be used for this session.
`void`	`setScrapingSessionNotifiable(ScrapingSessionNotifiable scrapingSessionNotifiable)` Sets the object the scraping session will use to notify its progress of.
`void`	`setScrapingSessionState(ScrapingSessionState scrapingSessionState)` Explicitly sets the state variable for the session.
`void`	`setScriptInstances(ScriptInstances scriptInstances)` Sets the script instances to be associated with this scrapeable file.
`void`	`setSessionVariablesFromMap(java.util.Map<java.lang.Object,java.lang.Object> map, boolean ignoreLowerCaseKeys)` Sets the value of all session variables that that match the keys in the Map to the values in the Map.
`void`	`setShouldBreakpoint(boolean shouldBreakpoint)` Sets whether or not the session should breakpoint at the next opportunity
`void`	`setStartTime(long startTime)` Sets the starting time to given value which is in milliseconds.
`void`	`setStatusMessage(java.lang.String statusMessage)` Sets the status message that should be persisted to the database once the scraping session ends.
`void`	`setStopScraping(boolean stopScraping)` Sets whether or not the session should stop scraping.
`void`	`setStopScraping(boolean forceSet, StopScrapingCallType stopScrapingCallType, java.lang.String explanation)` Sets whether or not the session should stop scraping.
`void`	`setStopScrapingOnExtractorPatternTimeout(boolean stopScrapingOnExtractorPatternTimeout)` Sets whether or not scraping should stop in the event of an extractor pattern timeout
`void`	`setStopScrapingOnMaxRequestAttemptsReached(boolean stopScrapingOnMaxRequestAttemptsReached)` Sets whether or not scraping should stop in the event of max request attempts reached.
`void`	`setStopScrapingOnScriptError(boolean stopScrapingOnScriptError)` Sets whether or not scraping should stop in the event of a script error.
`void`	`setTerminateProxiesOnCompletion(boolean terminateProxiesOnCompletion)` Indicates whether or not proxies should be terminated on completion
`void`	`setTimeout(int timeout)` Sets the timeout, in minutes, for the scraping session.
`void`	`setTimeZone(java.lang.String timeZone)` Sets the time zone that will be used when using a method that returns a time formatted as a string, but doesn't take a time.
`void`	`setTimeZone(java.util.TimeZone timeZone)` Sets the time zone that will be used when using a method that returns a time formatted as a string, but doesn't take a time.
`void`	`setURLToUseAsReferer(java.net.URL urlToUseAsReferer)` Sets the URL that should be used for the referer HTTP header for scrapeable files subsequent to this one.
`void`	`setUseOnlySSLv3(boolean useOnlySSLv3)` Sets whether or not only SSLv3 should be used when connecting to remote servers.
`void`	`setUseProxyFromPool(boolean useProxyFromPool)` Sets whether or not a proxy should be used for the current request(s).
`void`	`setUserAgent(java.lang.String userAgent)` Sets the user-agent to be used in HTTP requests.
`void`	`setUseServerCharacterSet(boolean useServerCharacterSet)` Sets whether the character set indicated by the server should be used.
`void`	`setUseStrictMode(boolean useStrictMode)` Determines whether or not strict mode should be used.
`void`	`setv(java.lang.String variable, java.lang.Object value)` Alias to setVariable.
`void`	`setVariable(java.lang.String variable, java.lang.Object value)` Sets the value of a session variable.
`void`	`setVariables(java.util.Map<java.lang.Object,java.lang.Object> variables)` Sets the value of all session variables that that match the keys in the Map to the values in the Map.
`void`	`setVariables(java.util.Map<java.lang.Object,java.lang.Object> variables, boolean ignoreLowerCaseKeys)` Sets the value of all session variables that that match the keys in the Map to the values in the Map.
`protected void`	`setWebClient(com.gargoylesoftware.htmlunit.WebClient webClient)` Sets the web client used in navigating.
`boolean`	`shouldStopScraping()` Indicates whether or not the session should stop scraping.
`void`	`startScraping()` Starts the session scraping.
`void`	`stopChildScrapingSessions()` Stops any running scraping session objects.
`void`	`stopScraping()` Indicates that the scraping session should stop scraping as soon as possible.
`void`	`stopScraping(StopScrapingCallType callType, java.lang.String explanation)` Indicates that the scraping session should stop scraping as soon as possible.
`void`	`terminateAllAnonymousProxies()` Stops all of the currently running proxy instances
`java.lang.String`	`toString()` Overridden so that the name appears as the title in the main tree.
`(package private) void`	`unlockBreakpointBlockedThreads()` This should be called at the end of the scrape.
`static ScrapingSession`	`unmarshalScrapingSession(java.io.Reader reader)` Unmarshals a scraping session from the given reader.
`void`	`validateSequences()` Checks each `ScrapeableFile` for duplicate sequences.
`void`	`waitForBreakpoint()` Waits for a breakpoint in the workbench.
`void`	`waitForBreakpoint(boolean pauseBackgroundThreads)` Deprecated. pauseBackgroundThreads was causing some locking issues, so it is now ignored
`void`	`waitForFileDownloadsToComplete()` Waits for any file downloads to complete before returning.
`void`	`warn(java.lang.Object message)` Sends an app event off to the view to be logged as WARN.
`void`	`warn(java.lang.Object message, java.lang.Throwable throwable)` Sends an app event off to the view to be logged as WARN.
`(package private) boolean`	`wasStoppedDuringRun()`
`void`	`webClose(java.lang.Object message)` Logs closing values to indicate the scrape is complete and what values were when everything finished.
`void`	`webClose(java.lang.Object message, java.lang.Object loggable)` Logs an error message to the web interface error message area.
`void`	`webDebug(java.lang.Object message)` Logs a debug message to the web interface error message area.
`void`	`webDebug(java.lang.Object message, boolean saveMessage)` Logs a debug message to the web interface error message area.
`void`	`webDebug(java.lang.Object message, boolean saveMessage, java.lang.Object loggable)` Logs a debug message to the web interface error message area.
`void`	`webDebug(java.lang.Object message, java.lang.Object loggable)` Logs a debug message to the web interface error message area.
`void`	`webError(java.lang.Object message)` Logs an error message to the web interface error message area.
`void`	`webError(java.lang.Object message, boolean saveMessage)` Logs an error message to the web interface error message area.
`void`	`webError(java.lang.Object message, boolean saveMessage, java.lang.Object loggable)` Logs an error message to the web interface error message area.
`void`	`webError(java.lang.Object message, java.lang.Object loggable)` Logs an error message to the web interface error message area.
`void`	`webInfo(java.lang.Object message)` Logs an info message to the web interface error message area.
`void`	`webInfo(java.lang.Object message, boolean saveMessage)` Logs an info message to the web interface error message area.
`void`	`webInfo(java.lang.Object message, boolean saveMessage, java.lang.Object loggable)` Logs an info message to the web interface error message area.
`void`	`webInfo(java.lang.Object message, java.lang.Object loggable)` Logs an info message to the web interface error message area.
`void`	`webWarn(java.lang.Object message)` Logs a warn message to the web interface error message area.
`void`	`webWarn(java.lang.Object message, boolean saveMessage)` Logs a warn message to the web interface error message area.
`void`	`webWarn(java.lang.Object message, boolean saveMessage, java.lang.Object loggable)` Logs a warn message to the web interface error message area.
`void`	`webWarn(java.lang.Object message, java.lang.Object loggable)` Logs a warn message to the web interface error message area.

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
public static org.apache.log4j.Logger log
```
    Used for logging.
  - STRING_ACCORDING_TO_COOKIE_SPEC
```
public static final java.lang.String STRING_ACCORDING_TO_COOKIE_SPEC
```
    Cookie policy constants.
    
    See Also:
    
    Constant Field Values
  - STRING_ACCEPT
```
public static final java.lang.String STRING_ACCEPT
```
    See Also:
    
    Constant Field Values
  - STRING_BEST_MATCH
```
public static final java.lang.String STRING_BEST_MATCH
```
    See Also:
    
    Constant Field Values
  - STRING_COMPATIBILITY
```
public static final java.lang.String STRING_COMPATIBILITY
```
    See Also:
    
    Constant Field Values
  - STRING_NETSCAPE_DRAFT
```
public static final java.lang.String STRING_NETSCAPE_DRAFT
```
    See Also:
    
    Constant Field Values
  - STRING_REJECT
```
public static final java.lang.String STRING_REJECT
```
    See Also:
    
    Constant Field Values
  - STRING_STRICT_MODE
```
public static final java.lang.String STRING_STRICT_MODE
```
    See Also:
    
    Constant Field Values
  - INT_ACCEPT
```
public static final int INT_ACCEPT
```
    See Also:
    
    Constant Field Values
  - INT_REJECT
```
public static final int INT_REJECT
```
    See Also:
    
    Constant Field Values
  - INT_BEST_MATCH
```
public static final int INT_BEST_MATCH
```
    See Also:
    
    Constant Field Values
  - INT_STRICT_MODE
```
public static final int INT_STRICT_MODE
```
    See Also:
    
    Constant Field Values
  - STRING_APACHE_HTTPCLIENT
```
public static final java.lang.String STRING_APACHE_HTTPCLIENT
```
    Constants used to determine the client to use for the session.
    
    See Also:
    
    Constant Field Values
  - STRING_NING_ASYNC_HTTPCLIENT
```
public static final java.lang.String STRING_NING_ASYNC_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - STRING_ASYNC_HTTPCLIENT_2
```
public static final java.lang.String STRING_ASYNC_HTTPCLIENT_2
```
    See Also:
    
    Constant Field Values
  - STRING_CURL_HTTPCLIENT
```
public static final java.lang.String STRING_CURL_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - INT_APACHE_HTTPCLIENT
```
public static final int INT_APACHE_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - INT_NING_ASYNC_HTTPCLIENT
```
public static final int INT_NING_ASYNC_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - INT_ASYNC_HTTPCLIENT_2
```
public static final int INT_ASYNC_HTTPCLIENT_2
```
    See Also:
    
    Constant Field Values
  - INT_CURL_HTTPCLIENT
```
public static final int INT_CURL_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - STRING_HTTP_CLIENT_HTTPCLIENT
```
public static final java.lang.String STRING_HTTP_CLIENT_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - STRING_HTTP_CLIENT_MOZILLA
```
public static final java.lang.String STRING_HTTP_CLIENT_MOZILLA
```
    See Also:
    
    Constant Field Values
  - STRING_HTTP_CLIENT_IE
```
public static final java.lang.String STRING_HTTP_CLIENT_IE
```
    See Also:
    
    Constant Field Values
  - INT_HTTP_CLIENT_HTTPCLIENT
```
public static final int INT_HTTP_CLIENT_HTTPCLIENT
```
    See Also:
    
    Constant Field Values
  - INT_HTTP_CLIENT_MOZILLA
```
public static final int INT_HTTP_CLIENT_MOZILLA
```
    See Also:
    
    Constant Field Values
  - INT_HTTP_CLIENT_IE
```
public static final int INT_HTTP_CLIENT_IE
```
    See Also:
    
    Constant Field Values
  - INFO_FLAVOR
```
public static final java.awt.datatransfer.DataFlavor INFO_FLAVOR
```
    Drag 'n drop stuff.
  - flavors
```
@NotNull
static java.awt.datatransfer.DataFlavor[] flavors
```
- Constructor Detail
  - ScrapingSession
```
public ScrapingSession()
```
    Needed by castor.
  - ScrapingSession
```
public ScrapingSession(@NotNull
                       ScrapingSession scrapingSession)
```
    Generates a new scraping session as a copy of the given one.
    
    Parameters:
    
    scrapingSession - The ScrapingSession to be copied.
  - ScrapingSession
```
public ScrapingSession(java.lang.String name)
```
    Generates a new ScrapingSession, given a string.
    
    Parameters:
    
    name - The name of the session.
  - ScrapingSession
```
public ScrapingSession(int scrapingSessionID,
                       java.lang.String name,
                       int cookieHandling,
                       int cookiePolicy,
                       int httpClientType,
                       int maxHTTPRequests,
                       java.lang.String externalProxyUsername,
                       java.lang.String externalProxyPassword,
                       java.lang.String externalProxyHost,
                       java.lang.String externalProxyPort,
                       java.lang.String externalNTProxyUsername,
                       java.lang.String externalNTProxyPassword,
                       java.lang.String externalNTProxyHost,
                       java.lang.String externalNTProxyPort,
                       boolean useStrictMode,
                       int folderID,
                       java.lang.String notes,
                       boolean anonymize,
                       boolean terminateProxiesOnCompletion,
                       int numberOfRequiredProxies,
                       int originatorEdition,
                       int loggingLevel,
                       java.lang.String characterSet,
                       java.lang.String keyStoreFilePath,
                       java.lang.String keyStorePassword,
                       boolean useOnlySSLv3,
                       java.lang.String createdByVersion,
                       long dateUpdated)
```
    Generates a new ScrapingSession with all of its basic information.
    
    Parameters:
    
    anonymize - Indicates whether the scraping session should be anonymized
    
    terminateProxiesOnCompletion - Indicates whether the proxies should be terminated
    
    numberOfRequiredProxies - The number of required proxies for the scrape
    
    originatorEdition - The edition from which the scraping session originated.
    
    loggingLevel - The logging level to use when the scraping session is running.
    
    scrapingSessionID - The ID of the scraping session.
    
    name - The name of the session.
    
    cookieHandling - Indicates how cookies should be handled.
    
    cookiePolicy - Indicates the cookie policy.
    
    httpClientType - Indicates the http-client.
    
    maxHTTPRequests - The maximum HTTP requests.
    
    externalProxyUsername - The external proxy username.
    
    externalProxyPassword - The external proxy password.
    
    externalProxyHost - The external proxy host.
    
    externalProxyPort - The external proxy port.
    
    externalNTProxyUsername - The external NT proxy username.
    
    externalNTProxyPassword - The external NT proxy password.
    
    externalNTProxyHost - The external NT proxy host.
    
    externalNTProxyPort - The external NT proxy port.
    
    useStrictMode - Whether or not strict mode should be used.
    
    folderID - The ID of the folder containing the object.
    
    notes - The notes.
    
    characterSet - The character set to use.
    
    dateUpdated - The time when the scraping session was last updated.
    
    keyStoreFilePath - The path to the keystore file.
    
    keyStorePassword - The keystore password.
    
    useOnlySSLv3 - Whether or not only SSLv3 should be used.
    
    createdByVersion - The version of ss that created this scraping session.
- Method Detail
  - unmarshalScrapingSession
```
@NotNull
 @InternalOnly
public static ScrapingSession unmarshalScrapingSession(java.io.Reader reader)
                                                                          throws org.exolab.castor.mapping.MappingException,
                                                                                 java.io.IOException,
                                                                                 org.exolab.castor.xml.ValidationException,
                                                                                 org.exolab.castor.xml.MarshalException
```
    Unmarshals a scraping session from the given reader.
    
    Parameters:
    
    reader - A Reader stream containing the scraping session to be unmarshalled.
    
    Throws:
    
    org.exolab.castor.mapping.MappingException
    
    java.io.IOException
    
    org.exolab.castor.xml.ValidationException
    
    org.exolab.castor.xml.MarshalException
  - prepareAnonymization
```
@InternalOnly
public void prepareAnonymization()
```
    If the scrape is set to be anonymized this will initialize all the required settings and launch the required number of proxy servers.
  - terminateAllAnonymousProxies
```
public void terminateAllAnonymousProxies()
```
    Description copied from interface: RunningScrapingSession
    
    Stops all of the currently running proxy instances
    
    Specified by:
    
    terminateAllAnonymousProxies in interface RunningScrapingSession
  - doLazyScrape
```
public boolean doLazyScrape()
```
    Indicates whether or not the session should do a "lazy" scrape.
    
    Returns:
    
    A boolean.
  - setDoLazyScrape
```
public void setDoLazyScrape(boolean doLazyScrape)
```
    Determines whether or not the session should do a "lazy" scrape.
    
    Parameters:
    
    doLazyScrape - A boolean.
  - getHTTPClientType
```
@InternalOnly
public int getHTTPClientType()
```
    Gets the HTTP client to be used throughout the session.
    
    Returns:
    
    The client as defined by one of the "HTTP" constants.
  - setHTTPClientType
```
@InternalOnly
public void setHTTPClientType(int httpClientType)
```
    Sets the HTTP client to be used throughout the session.
    
    Parameters:
    
    httpClientType - The client as defined by one of the "HTTP" constants.
  - mapHTTPClientTypeStringToInt
```
@InternalOnly
public static int mapHTTPClientTypeStringToInt(@NotNull
                                                              java.lang.String httpClientType)
```
    Maps an HTTP client string to an int.
    
    Parameters:
    
    httpClientType - The string representing the HTTP client.
    
    Returns:
    
    The corresponding int.
  - mapHTTPClientIntToString
```
@NotNull
 @InternalOnly
public static java.lang.String mapHTTPClientIntToString(int httpClient)
```
    Maps an HTTP client int to a human-readable string.
    
    Parameters:
    
    httpClient - The int representing the HTTP client.
    
    Returns:
    
    The corresponding string.
  - getMaxConcurrentFileDownloads
```
@RequiredVersion(value=1)
public int getMaxConcurrentFileDownloads()
```
    Gets the maximum number of concurrent file downloads to a allow.
    
    Returns:
    
    The maximum number of downloads.
  - setMaxConcurrentFileDownloads
```
@RequiredVersion(value=1)
public void setMaxConcurrentFileDownloads(int maxConcurrentFileDownloads)
```
    Sets the maximum number of concurrent file downloads to a allow.
    
    Parameters:
    
    maxConcurrentFileDownloads - The maximum number of downloads.
  - downloadFile
```
@RequiredVersion(value=2)
public boolean downloadFile(java.lang.String urlString,
                                                       java.lang.String fileName,
                                                       int maxNumAttempts,
                                                       boolean doLazy)
```
    A utility method for downloading a resource and writing it to a file.
    
    Parameters:
    
    fileName - The full path that the downloaded resource should be written to. Example "C:\\downloaded.gif". The "\" character should be included in the path twice for each instance of it's use in order for it to be not treated as an escape character.
    
    urlString - The Uniform Resource Locator of the resource.
    
    maxNumAttempts - The number of attempts the download should be attempted in the case of failures.
    
    doLazy - Indicates whether or not the file should be downloaded in its own thread.
    
    Returns:
    
    A boolean indicating whether or not the download succeeded or failed.
  - downloadFile
```
@RequiredVersion(value=1)
public boolean downloadFile(java.lang.String urlString,
                                                       java.lang.String fileName,
                                                       int maxNumAttempts)
```
    A utility method for downloading a resource and writing it to a file.
    
    Parameters:
    
    fileName - The full path that the downloaded resource should be written to. Example "C:\\downloaded.gif". The "\" character should be included in the path twice for each instance of it's use in order for it to be not treated as an escape character.
    
    urlString - The Uniform Resource Locator of the resource.
    
    maxNumAttempts - The number of attempts the download should be attempted in the case of failures.
    
    Returns:
    
    A boolean indicating whether or not the download succeeded or failed.
  - downloadFile
```
@RequiredVersion(value=1)
public boolean downloadFile(@Nullable
                                                       java.lang.String urlString,
                                                       @Nullable
                                                       java.lang.String fileName)
```
    A utility method for downloading a resource and writing it to a file.
    
    Specified by:
    
    downloadFile in interface RunningScrapingSession
    
    Parameters:
    
    fileName - The full path that the downloaded resource should be written to. Example "C:\\downloaded.gif". The "\" character should be included in the path twice for each instance of it's use in order for it to be not treated as an escape character.
    
    urlString - The Uniform Resource Locator of the resource.
    
    Returns:
    
    A boolean indicating whether or not the download succeeded or failed.
  - waitForFileDownloadsToComplete
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_ONLY)
public void waitForFileDownloadsToComplete()
```
    Waits for any file downloads to complete before returning.
  - setID
```
@InternalOnly
public void setID(int scrapingSessionID)
```
    Sets the ID of the scraping session.
    
    Parameters:
    
    scrapingSessionID - The id of the scraping session
  - getID
```
@InternalOnly
public int getID()
```
    Gets the ID of the scraping session.
    
    Specified by:
    
    getID in interface ScriptInstancesContainer
    
    Returns:
    
    The ID.
  - getName
```
@Nullable
public java.lang.String getName()
```
    Gets the name.
    
    Specified by:
    
    getName in interface ScriptInstancesContainer
    
    Returns:
    
    The name.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name.
    
    Parameters:
    
    name - The name.
  - getNameUpperCase
```
@Nullable
 @InternalOnly
public java.lang.String getNameUpperCase()
```
    Gets the name in upper case (used for comparing with other scraping sessions).
    
    Returns:
    
    The name in upper-case.
  - getFolder
```
@Nullable
 @InternalOnly
public Folder getFolder()
```
    Gets the folder containing this object.
    
    Specified by:
    
    getFolder in interface Folderable
    
    Returns:
    
    The folder.
  - setFolder
```
@InternalOnly
public void setFolder(@Nullable
                                     Folder folder)
```
    Sets the folder containing this object.
    
    Specified by:
    
    setFolder in interface Folderable
    
    Parameters:
    
    folder - The folder.
  - removeFromFolder
```
@InternalOnly
public void removeFromFolder()
```
    Removes the object from its current folder.
    
    Specified by:
    
    removeFromFolder in interface Folderable
  - moveToNewFolder
```
@InternalOnly
public void moveToNewFolder(Folder folder)
```
    Moves the object to a new folder.
    
    Specified by:
    
    moveToNewFolder in interface Folderable
    
    Parameters:
    
    folder - The Folder to which the object should be moved.
  - getCookiePolicy
```
@InternalOnly
public int getCookiePolicy()
```
    Gets the cookie policy option.
    
    Returns:
    
    The option, as an int.
  - getCookiePolicyAsHttpClientString
```
@InternalOnly
public java.lang.String getCookiePolicyAsHttpClientString()
```
    Gets the cookie policy as a String that is friendly to HttpClient 4.
    
    Returns:
    
    The cookie policy, as defined by one of the HttpClient constants.
  - setCookiePolicy
```
@InternalOnly
public void setCookiePolicy(int cookiePolicy)
```
    Sets the cookie policy option.
    
    Parameters:
    
    cookiePolicy - The option, as an int.
  - mapCookiePolicyHumanReadableStringToInt
```
@InternalOnly
public static int mapCookiePolicyHumanReadableStringToInt(@NotNull
                                                                         java.lang.String cookiePolicy)
```
    Maps a cookie policy string to an int.
    
    Parameters:
    
    cookiePolicy - The string representing the cookie policy.
    
    Returns:
    
    The corresponding int.
  - mapCookiePolicyIntToHumanReadableString
```
@NotNull
 @InternalOnly
public static java.lang.String mapCookiePolicyIntToHumanReadableString(int cookiePolicy)
```
    Maps a cookie policy int to a human-readable string.
    
    Parameters:
    
    cookiePolicy - The int representing the cookie policy.
    
    Returns:
    
    The corresponding string.
  - setNode
```
@InternalOnly
public void setNode(javax.swing.tree.DefaultMutableTreeNode node)
```
    Sets the node representing this session.
    
    Parameters:
    
    node - A DefaultMutableTreeNode.
  - getNode
```
@Nullable
 @InternalOnly
public javax.swing.tree.DefaultMutableTreeNode getNode()
```
    Gets the node representing this session.
    
    Returns:
    
    A DefaultMutableTreeNode.
  - getNextDefaultScrapeableFileName
```
@InternalOnly
public java.lang.String getNextDefaultScrapeableFileName()
```
    Gets the name of a new scrapeable file, ensuring it isn't a duplicate.
    
    Returns:
    
    The name of the scrapeable file.
  - getNumScrapeableFiles
```
@InternalOnly
public int getNumScrapeableFiles()
```
    Returns the number of scrapeable files currently held by the session.
    
    Returns:
    
    The number of files.
  - getNumScrapeableFilesWithSequence
```
@InternalOnly
public int getNumScrapeableFilesWithSequence()
```
    Returns the number of scrapeable files currently held by the session that use a valid sequence.
    
    Returns:
    
    The number of files.
  - resetInitialValues
```
@InternalOnly
public void resetInitialValues()
```
    Resets a series of values to ensure that the scraping session starts fresh.
  - resetContainsNullableTokens
```
@InternalOnly
public void resetContainsNullableTokens()
```
    Causes the containsNullableTokens value for each extractor pattern associated with each scrapeable file to be reset.
  - getCookies
```
@NotNull
 @Deprecated
 @InternalOnly
public org.apache.commons.httpclient.Cookie[] getCookies()
```
    Deprecated. Use the getCookieList() method instead.
    
    Gets an array of Cookie objects corresponding to the current session.
    
    Returns:
    
    An array of Cookie objects.
  - getCookieList
```
@NotNull
public java.util.List<ScrapingCookie> getCookieList()
```
    Returns a list of cookies for the current session
    
    Returns:
    
    A list of cookies for the current session
  - getHttpClient
```
@Nullable
public ScrapingHttpClient getHttpClient()
```
    Gets the HTTP client to be used in scraping.
    
    Returns:
    
    A CloseableHttpClient.
  - setHttpClient
```
public void setHttpClient(@Nullable
                          ScrapingHttpClient httpClient)
```
    Sets the HTTP client to be used in scraping.
    
    Parameters:
    
    httpClient - A CloseableHttpClient.
  - setHttpClient
```
public void setHttpClient(@Nullable
                          ScrapingHttpClient httpClient,
                          boolean clientWillBeClosedExternally)
```
    Sets the HTTP client to be used in scraping. Set the clientWillBeClosedExternally flag to true if this http client is coming from someplace else, so we shouldn't close it automatically when the scrape finishes. This would largely be something like inheriting the state from the parent scrape (which means it's client as well)
    
    Parameters:
    
    httpClient - A CloseableHttpClient.
    
    clientWillBeClosedExternally - True if the client being passed in will be closed someplace else, so should not be automatically closed
  - getWebClient
```
@InternalOnly
 @NotNull
public com.gargoylesoftware.htmlunit.WebClient getWebClient()
```
    Gets the HTMLUnit web client used in navigating.
    
    Returns:
    
    The WebClient object.
  - setWebClient
```
protected void setWebClient(@Nullable
                            com.gargoylesoftware.htmlunit.WebClient webClient)
```
    Sets the web client used in navigating.
    
    Parameters:
    
    webClient - The WebClient object.
  - addScrapeableFile
```
@InternalOnly
public void addScrapeableFile(@Nullable
                                             ScrapeableFile scrapeableFile)
```
    Inserts a ScrapeableFile into the session.
    
    Parameters:
    
    scrapeableFile - A ScrapeableFile.
  - removeScrapeableFile
```
@InternalOnly
public void removeScrapeableFile(@Nullable
                                                java.lang.String name)
```
    Removes a scrapeable file from the session.
    
    Parameters:
    
    name - The name of the scrapeable file to be removed.
  - removeScrapeableFile
```
@InternalOnly
public void removeScrapeableFile(int sequence)
```
    Removes a scrapeable file from the session.
    
    Parameters:
    
    sequence - The sequence of the scrapeable file to be removed.
  - replaceScrapeableFile
```
@InternalOnly
public void replaceScrapeableFile(@Nullable
                                                 ScrapeableFile scrapeableFile)
```
    Replaces an existing scrapeable file with the given scrapeable file carrying the same name.
    
    Parameters:
    
    scrapeableFile - The ScrapeableFile to replace.
  - bumpScrapeableFileSequences
```
@InternalOnly
public void bumpScrapeableFileSequences(int minimumSequence,
                                                       int maximumSequence,
                                                       boolean bumpUp)
```
    Bumps the sequence up or down by one for any ScrapeableFile whose sequence falls in between the given sequences.
    
    Parameters:
    
    minimumSequence - The minimum sequence to compare with.
    
    maximumSequence - The maximum sequence to compare with.
    
    bumpUp - Indicates that sequences should be bumped up.
  - validateSequences
```
@InternalOnly
public void validateSequences()
```
    Checks each ScrapeableFile for duplicate sequences. If a duplicate sequence is found, the scrapeable file is given no sequence. This method also ensures there aren't any holes in the sequences.
  - getScrapeableFilesIterator
```
@InternalOnly
public java.util.Iterator getScrapeableFilesIterator()
```
    An Iterator used to cycle through the ScrapeableFile objects held by this object.
    
    Returns:
    
    An Iterator.
  - getScrapeableFiles
```
@Nullable
 @InternalOnly
public java.util.HashSet getScrapeableFiles()
```
    Gets all ScrapeableFiles associated with this scraping session. Note that this method is only public because of Castor.
    
    Returns:
    
    The ScrapeableFiles as a HashSet.
  - setScrapeableFiles
```
@InternalOnly
public void setScrapeableFiles(java.util.HashSet scrapeableFiles)
```
    Sets all scrapeable files. Needed by castor.
    
    Parameters:
    
    scrapeableFiles - A HashSet of ScrapeableFiles.
  - getScrapeableFile
```
@InternalOnly
public ScrapeableFile getScrapeableFile(int sequence)
```
    Gets a scrapeable file from the session.
    
    Parameters:
    
    sequence - The sequence of the scrapeable file to be retrieved.
  - getScrapeableFileByID
```
@InternalOnly
public ScrapeableFile getScrapeableFileByID(int scrapeableFileID)
```
    Gets a scrapeable file from the session by its ID.
    
    Parameters:
    
    scrapeableFileID - The ID of the scrapeable file to be retrieved.
  - getNonSequencedScrapeableFileBySequence
```
@InternalOnly
public ScrapeableFile getNonSequencedScrapeableFileBySequence(int sequence)
```
    Gets a scrapeable file from the session that doesn't have a sequence, but is found by cycling through the scrapeable files alphabetically.
    
    Parameters:
    
    sequence - The sequence of the scrapeable file to be retrieved.
  - getScrapeableFile
```
@Nullable
 @InternalOnly
public ScrapeableFile getScrapeableFile(@Nullable
                                                                   java.lang.String name)
```
    Gets a scrapeable file from the session.
    
    Parameters:
    
    name - The name of the scrapeable file to be retrieved.
    
    Returns:
    
    The scrapeable file with the given name, or null if not found
  - ensureScrapeableFilesHaveScrapingSessionReference
```
@InternalOnly
public void ensureScrapeableFilesHaveScrapingSessionReference()
```
    Ensures that all constituent scrapeable file objects have a reference to this scraping session.
  - getScrapeableFileCaseInsensitive
```
@Nullable
 @InternalOnly
public ScrapeableFile getScrapeableFileCaseInsensitive(java.lang.String name)
```
    Gets a scrapeable file from the session, without regard to case.
    
    Parameters:
    
    name - The name of the scrapeable file to be retrieved.
    
    Returns:
    
    The scrapeable file with the given name, or null if not found
  - toString
```
@Nullable
public java.lang.String toString()
```
    Overridden so that the name appears as the title in the main tree.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The name of the session.
  - getScriptInstances
```
@InternalOnly
public ScriptInstances getScriptInstances()
```
    Returns a ScriptInstances object containing all script instances associated with this scrapeable file.
    
    Specified by:
    
    getScriptInstances in interface ScriptInstancesContainer
    
    Returns:
    
    The script instances.
  - setScriptInstances
```
@InternalOnly
public void setScriptInstances(ScriptInstances scriptInstances)
```
    Sets the script instances to be associated with this scrapeable file.
    
    Specified by:
    
    setScriptInstances in interface ScriptInstancesContainer
    
    Parameters:
    
    scriptInstances - The script instances.
  - ensureFullyLoaded
```
@InternalOnly
public void ensureFullyLoaded()
```
    Ensures that the scraping session is completely loaded.
    Note: this method is synchronized because of a case we encountered where the scraping session was being copied by multiple scraping sessions that all invoked it. Some of the scraping sessions would start copying it before it finished loading.
  - save
```
@InternalOnly
public void save()
```
    Saves the scraping session to the database.
  - setCookie
```
@RequiredVersion(value=1)
public void setCookie(@NotNull
                                                 java.lang.String domain,
                                                 @NotNull
                                                 java.lang.String name,
                                                 @NotNull
                                                 java.lang.String value)
```
    Allows a cookie to be set in the current session state.
    
    Specified by:
    
    setCookie in interface RunningScrapingSession
    
    Parameters:
    
    domain - The domain of the cookie.
    
    name - The name of the cookie.
    
    value - The value the cookie should hold.
  - setCookie
```
@RequiredVersion(value=1)
public void setCookie(@NotNull
                                                 java.lang.String domain,
                                                 @NotNull
                                                 java.lang.String name,
                                                 @NotNull
                                                 java.lang.String value,
                                                 java.lang.String path,
                                                 @Nullable
                                                 java.util.Date expires,
                                                 boolean secure)
```
    Sets a cookie
    
    Parameters:
    
    name - the cookie name
    
    value - the cookie value
    
    domain - the domain this cookie can be sent to
    
    path - the path prefix for which this cookie can be sent
    
    expires - the Date at which this cookie expires, or null if the cookie expires at the end of the session
    
    secure - if true this cookie can only be sent over secure connections
    
    Throws:
    
    java.lang.IllegalArgumentException - If cookie name is null or blank, cookie name contains a blank, or cookie name starts with character $
  - setCookie
```
@RequiredVersion(value=1)
public void setCookie(@NotNull
                                                 ScrapingCookie cookie)
```
    Allows a cookie to be set in the current session state.
    
    Parameters:
    
    cookie - The cookie to be set
    
    Since:
    
    7.0.11a
  - clearCookies
```
@RequiredVersion(value=2)
public void clearCookies()
```
    Clears all cookies.
    
    Specified by:
    
    clearCookies in interface RunningScrapingSession
  - delete
```
@InternalOnly
public void delete()
```
    Deletes the session from the database.
    
    Specified by:
    
    delete in interface Deleteable
  - startScraping
```
@InternalOnly
public void startScraping()
```
    Starts the session scraping.
  - executeScript
```
@RequiredVersion(value=1)
public void executeScript(java.lang.String scriptName)
                                              throws java.lang.Exception
```
    Executes the named script.
    
    Specified by:
    
    executeScript in interface RunningScrapingSession
    
    Parameters:
    
    scriptName - The name of the script to execute.
    
    Throws:
    
    java.lang.Exception - if the script couldn't be found
  - processPreScrapingScripts
```
protected void processPreScrapingScripts()
```
    Processes any scripts before files are to be scraped.
  - processPostScrapingScripts
```
protected void processPostScrapingScripts()
```
    Processes any scripts after files are to be scraped.
  - getVariable
```
@Nullable
public java.lang.Object getVariable(@NotNull
                                               java.lang.String variable)
```
    Gets the value of a session variable. Required by RunningScrapingSession.
    
    Specified by:
    
    getVariable in interface RunningScrapingSession
    
    Parameters:
    
    variable - The name of the variable.
    
    Returns:
    
    The value of the variable.
  - getInternalVariable
```
@InternalOnly
 @Nullable
public <T> T getInternalVariable(@NotNull
                                                            java.lang.String key)
```
    Gets the value of an internal variable. Required by RunningScrapingSession.
    
    Parameters:
    
    key - The name of the variable.
    
    Returns:
    
    The value of the variable.
  - getv
```
@Nullable
public java.lang.Object getv(@NotNull
                                        java.lang.String variable)
```
    Alias to getVariable.
    
    Parameters:
    
    variable - The name of the variable.
    
    Returns:
    
    The value of the variable
  - getAllSessionVariablesAsURLEncodedString
```
@NotNull
protected java.lang.String getAllSessionVariablesAsURLEncodedString()
```
    Gets all session variables as a URL-encoded string.
    
    Returns:
    
    The URL-encoded string.
  - setVariable
```
public void setVariable(@NotNull
                        java.lang.String variable,
                        @Nullable
                        java.lang.Object value)
```
    Sets the value of a session variable. Required by RunningScrapingSession.
    
    Specified by:
    
    setVariable in interface RunningScrapingSession
    
    Parameters:
    
    variable - The variable.
    
    value - The value of the variable.
  - setInternalVariable
```
@InternalOnly
public void setInternalVariable(@NotNull
                                               java.lang.String key,
                                               @Nullable
                                               java.lang.Object value)
```
    Sets the value of an internal variable. Required by RunningScrapingSession.
    
    Parameters:
    
    key - The variable.
    
    value - The value of the variable.
  - setv
```
public void setv(@NotNull
                 java.lang.String variable,
                 @Nullable
                 java.lang.Object value)
```
    Alias to setVariable.
    
    Parameters:
    
    variable - The variable.
    
    value - The value of the variable.
  - addSessionVariableMonitor
```
@Deprecated
public void addSessionVariableMonitor(java.lang.String monitoredVariable)
```
    Deprecated.
    
    Does nothing. Use addMonitoredVariable(String) instead.
    
    Parameters:
    
    monitoredVariable - The name of the monitored variable
  - clearAllSessionVariables
```
public void clearAllSessionVariables()
```
    Clears all session variables.
  - convertHTMLEntitiesInVariable
```
public void convertHTMLEntitiesInVariable(@NotNull
                                          java.lang.String variable)
```
    Replaces HTML entities in a variable with their non-entity equivalents.
    
    Parameters:
    
    variable - The name of the variable.
  - loadVariables
```
@RequiredVersion(value=2)
public void loadVariables(@NotNull
                                                     java.lang.String fileToReadFrom)
```
    Reads in and loads the session variables that were previously saved to a file.
    
    Parameters:
    
    fileToReadFrom - The file to read the variables from.
  - saveVariables
```
@RequiredVersion(value=2)
public void saveVariables(@NotNull
                                                     java.lang.String fileToSaveTo)
```
    Writes out the current session variables to a file.
    
    Specified by:
    
    saveVariables in interface RunningScrapingSession
    
    Parameters:
    
    fileToSaveTo - The file to save the variables to.
  - addToVariable
```
@RequiredVersion(value=1)
public void addToVariable(@NotNull
                                                     java.lang.String variable,
                                                     int value)
```
    Adds a value to a session variable.
    
    Specified by:
    
    addToVariable in interface RunningScrapingSession
    
    Parameters:
    
    variable - The name of the session variable.
    
    value - The value to add.
  - getScrapingSessionState
```
@NotNull
 @InternalOnly
public ScrapingSessionState getScrapingSessionState()
```
    Gets the session state for scripts as scrapeable files are being processed.
    
    Returns:
    
    The session state.
  - setScrapingSessionState
```
@InternalOnly
public void setScrapingSessionState(@Nullable
                                                   ScrapingSessionState scrapingSessionState)
```
    Explicitly sets the state variable for the session.
    
    Parameters:
    
    scrapingSessionState - The ScrapingSessionState
  - resetScrapingSessionState
```
@InternalOnly
public void resetScrapingSessionState()
```
    Resets the scraping session state.
  - setScrapingSessionNotifiable
```
@InternalOnly
public void setScrapingSessionNotifiable(@Nullable
                                                        ScrapingSessionNotifiable scrapingSessionNotifiable)
```
    Sets the object the scraping session will use to notify its progress of.
    
    Parameters:
    
    scrapingSessionNotifiable - The object.
  - getScrapingSessionNotifiable
```
@Nullable
 @InternalOnly
public ScrapingSessionNotifiable getScrapingSessionNotifiable()
```
    Gets the object the scraping session will use to notify its progress of.
    
    Specified by:
    
    getScrapingSessionNotifiable in interface RunningScrapingSession
    
    Returns:
    
    The object.
  - log
```
public void log(int message)
```
    Sends an app event off to the view to be logged.
    
    Parameters:
    
    message - The message to be logged.
  - log
```
public void log(java.lang.Object message)
```
    Sends an app event off to the view to be logged.
    
    Specified by:
    
    log in interface RunningScrapingSession
    
    Parameters:
    
    message - The message to be logged.
  - logDebug
```
public void logDebug(java.lang.Object message)
              throws java.lang.Exception
```
    Sends an app event off to the view to be logged as DEBUG.
    
    Parameters:
    
    message - The message to be logged.
    
    Throws:
    
    java.lang.Exception
  - logDebug
```
@RequiredVersion(value=1)
public void logDebug(java.lang.String message)
```
    Sends an app event off to the view to be logged as DEBUG.
    
    Parameters:
    
    message - The message to be logged.
  - logInfo
```
public void logInfo(java.lang.Object message)
```
    Sends an app event off to the view to be logged as INFO.
    
    Parameters:
    
    message - The message to be logged.
  - logInfo
```
public void logInfo(java.lang.String message)
```
    Sends an app event off to the view to be logged as INFO.
    
    Parameters:
    
    message - The message to be logged.
  - logWarn
```
public void logWarn(java.lang.String message)
```
    Sends an app event off to the view to be logged as WARN.
    
    Parameters:
    
    message - The message to be logged.
  - logWarn
```
public void logWarn(java.lang.Object message)
```
    Sends an app event off to the view to be logged as WARN.
    
    Parameters:
    
    message - The message to be logged.
  - logError
```
public void logError(java.lang.String message)
```
    Sends an app event off to the view to be logged as ERROR.
    
    Parameters:
    
    message - The message to be logged.
  - logError
```
public void logError(java.lang.Object message)
```
    Sends an app event off to the view to be logged as ERROR.
    
    Parameters:
    
    message - The message to be logged.
  - debug
```
public void debug(java.lang.Object message)
```
    Sends an app event off to the view to be logged as DEBUG.
    
    Parameters:
    
    message - The message to be logged
  - debug
```
public void debug(java.lang.Object message,
                  java.lang.Throwable throwable)
```
    Sends an app event off to the view to be logged as DEBUG.
    
    Parameters:
    
    message - The message to be logged
    
    throwable - A throwable to log with the message
  - info
```
public void info(java.lang.Object message)
```
    Sends an app event off to the view to be logged as INFO.
    
    Parameters:
    
    message - The message to be logged
  - info
```
public void info(java.lang.Object message,
                 java.lang.Throwable throwable)
```
    Sends an app event off to the view to be logged as INFO.
    
    Parameters:
    
    message - The message to be logged
    
    throwable - A throwable to log with the message
  - warn
```
public void warn(java.lang.Object message)
```
    Sends an app event off to the view to be logged as WARN.
    
    Parameters:
    
    message - The message to be logged
  - warn
```
public void warn(java.lang.Object message,
                 java.lang.Throwable throwable)
```
    Sends an app event off to the view to be logged as WARN.
    
    Parameters:
    
    message - The message to be logged
    
    throwable - A throwable to log with the message
  - error
```
public void error(java.lang.Object message)
```
    Sends an app event off to the view to be logged as ERROR.
    
    Parameters:
    
    message - The message to be logged
  - error
```
public void error(java.lang.Object message,
                  java.lang.Throwable throwable)
```
    Sends an app event off to the view to be logged as ERROR.
    
    Parameters:
    
    message - The message to be logged
    
    throwable - A throwable to log with the message
  - logError
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logError(java.lang.Object message,
                                                                                                                       @NotNull
                                                                                                                       java.lang.Throwable t)
```
    Sends an app event off to the view to be logged as ERROR.
    
    Parameters:
    
    message - The message to be logged.
  - logVariables
```
public void logVariables()
                  throws java.lang.Exception
```
    Outputs all session variables to the log.
    
    Throws:
    
    java.lang.Exception
  - logVariables
```
@RequiredVersion(value=1)
public void logVariables(@Nullable
                                                    ScriptContext scriptContext)
```
    Outputs all session variables to the log.
    
    Parameters:
    
    scriptContext - So that local variables can be logged.
  - scrapeString
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void scrapeString(java.lang.String scrapeableFileName,
                                                                                                                           java.lang.String content)
                                                                                                                    throws java.lang.Exception
```
    Calls a scrapeable file using the given contents as the response rather than issuing a request
    
    Parameters:
    
    scrapeableFileName - The name of the file to scrape
    
    content - The content to use as the last response
    
    Throws:
    
    java.lang.Exception - If an error occurs trying to load the scrapeable file
  - scrapeString
```
public void scrapeString(@Nullable
                         ScrapeableFile scrapeableFile,
                         java.lang.String content)
```
    Scrapes a file using the given string for the last response instead of issuing a request
    
    Parameters:
    
    scrapeableFile - The scrapeable file to scrape
    
    content - The content to use for the last response
  - scrapeFile
```
public void scrapeFile(@Nullable
                       ScrapeableFile scrapeableFile)
```
    Scrapes a file.
    
    Parameters:
    
    scrapeableFile - The file to be scraped.
  - getNumActiveScrapeableFiles
```
@InternalOnly
public int getNumActiveScrapeableFiles()
```
    Gets the number of active scrapeable files.
    
    Returns:
    
    The number.
  - getLatestActiveScrapeableFile
```
@InternalOnly
public ScrapeableFile getLatestActiveScrapeableFile()
```
    Gets the scrapeable file most recently added to the active scrapeable files.
    
    Returns:
    
    The ScrapeableFile.
  - getCreatedByVersion
```
@Nullable
public java.lang.String getCreatedByVersion()
```
    Gets the version of ss that originally created the scraping session.
    
    Returns:
    
    The version number.
  - setCreatedByVersion
```
public void setCreatedByVersion(java.lang.String createdByVersion)
```
    Sets the version of ss that originally created the scraping session.
    
    Parameters:
    
    createdByVersion - The version number.
  - isCreatedByVersionAtLeast
```
public boolean isCreatedByVersionAtLeast(@NotNull
                                         java.lang.String compareToVersion)
```
    Indicates whether or not the version that created this scraping session is greater than or equal to the given version. If the created by version hasn't been set this method will return false.
    
    Parameters:
    
    compareToVersion - The version to compare to.
  - getURLToUseAsReferer
```
@Nullable
public java.net.URL getURLToUseAsReferer()
```
    Gets the URL that should be used for the referer HTTP header for scrapeable files subsequent to this one.
    
    Returns:
    
    The referer URL.
  - setURLToUseAsReferer
```
@InternalOnly
public void setURLToUseAsReferer(java.net.URL urlToUseAsReferer)
```
    Sets the URL that should be used for the referer HTTP header for scrapeable files subsequent to this one.
    
    Parameters:
    
    urlToUseAsReferer - The URL to use as a referer.
  - scrapeFile
```
public void scrapeFile(java.lang.String scrapeableFileName)
                throws java.lang.Exception
```
    Scrapes a file.
    
    Specified by:
    
    scrapeFile in interface RunningScrapingSession
    
    Parameters:
    
    scrapeableFileName - The name of the file to be scraped.
    
    Throws:
    
    java.lang.Exception
  - pause
```
public void pause(long time)
           throws java.lang.Exception
```
    Indicates that the scraping session should pause for the given number of milliseconds.
    
    Specified by:
    
    pause in interface RunningScrapingSession
    
    Parameters:
    
    time - The amount of time to pause, in milliseconds.
    
    Throws:
    
    java.lang.Exception
  - getCurrentScriptContext
```
@InternalOnly
 @Nullable
public ScriptContext getCurrentScriptContext()
```
    Gets the current ScriptContext. Used by the BreakpointFrame.
    
    Returns:
    
    A ScriptContext object.
  - setCurrentScriptContext
```
@InternalOnly
public void setCurrentScriptContext(ScriptContext currentScriptContext)
```
    Sets the current ScriptContext. Used by the BreakpointFrame.
    
    Parameters:
    
    currentScriptContext - A ScriptContext object.
  - breakpoint
```
public void breakpoint()
```
    Performs a breakpoint.
    
    Specified by:
    
    breakpoint in interface RunningScrapingSession
  - breakpoint
```
@InternalOnly
public void breakpoint(@Nullable
                                      ScriptContext scriptContext)
```
    Performs a breakpoint.
    
    Parameters:
    
    scriptContext - The ScriptContext whose information should be displayed.
  - sendMail
```
public void sendMail(java.lang.String subject,
                     java.lang.String body,
                     java.lang.String recipients,
                     java.lang.String attachments,
                     java.lang.String headers)
              throws java.lang.Exception
```
    Sends mail to a pre-specified SMTP server. All exceptions will be caught by the user of this method.
    
    Specified by:
    
    sendMail in interface RunningScrapingSession
    
    Parameters:
    
    subject - The subject line of the e-mail.
    
    body - The text of the body of the e-mail.
    
    recipients - A comma separated list of recipients.
    
    attachments - A comma separated list of local files to be attached.
    
    headers - A tab separated list of additional headers one would like to add to the e-mail.
    
    Throws:
    
    java.lang.Exception
  - stopScraping
```
public void stopScraping()
```
    Indicates that the scraping session should stop scraping as soon as possible.
    
    Specified by:
    
    stopScraping in interface RunningScrapingSession
  - stopScraping
```
public void stopScraping(@NotNull
                         StopScrapingCallType callType,
                         @Nullable
                         java.lang.String explanation)
```
    Indicates that the scraping session should stop scraping as soon as possible.
    
    Specified by:
    
    stopScraping in interface RunningScrapingSession
    
    Parameters:
    
    callType - The type of stop being issued
    
    explanation - An explanation string for the stop
  - addEventCallback
```
@RequiredVersion(value=1)
public <T extends AbstractEventData> void addEventCallback(@NotNull
                                                                                      EventFireTime<T> eventTime,
                                                                                      @NotNull
                                                                                      EventHandler<T> callback)
```
    Add a runnable that will be executed at the given time. The priority it will be added at is 0.
    
    Parameters:
    
    eventTime - The time to execute the callback
    
    callback - The callback to execute
    
    Since:
    
    6.0.55a
  - addEventCallbackWithPriority
```
@RequiredVersion(value=1)
public <T extends AbstractEventData> void addEventCallbackWithPriority(@NotNull
                                                                                                  EventFireTime<T> eventTime,
                                                                                                  @NotNull
                                                                                                  EventHandler<T> callback,
                                                                                                  int priority)
```
    Add a runnable that will be executed at the given time and priority. Any events added with a higher priority will be executed before this, and any with a lower priority are executed after. For those on the same priority level, they are executed in the reverse order they were added (the most recently added is run first, the first added will be run last)
    
    Parameters:
    
    eventTime - The time to execute the callback
    
    callback - The callback to execute
    
    priority - The priority for this callback. Lower numbers are higher priority.
    
    Since:
    
    6.0.55a
  - removeEventCallback
```
@RequiredVersion(value=1)
public <T extends AbstractEventData> void removeEventCallback(@NotNull
                                                                                         EventFireTime<T> eventTime,
                                                                                         @NotNull
                                                                                         EventHandler<T> callback)
```
    Remove a runnable that will be executed at the given time
    
    Parameters:
    
    eventTime - The time to execute the callback
    
    callback - The callback to remove
    
    Since:
    
    6.0.55a
  - clearCallbacksForTime
```
@RequiredVersion(value=1)
public <T extends AbstractEventData> void clearCallbacksForTime(@NotNull
                                                                                           EventFireTime<T> eventTime)
```
    Clears the callbacks for the specified time
    
    Parameters:
    
    eventTime - The time to clear
    
    Since:
    
    6.0.55a
  - getShouldBreakpoint
```
@InternalOnly
public boolean getShouldBreakpoint()
```
    Gets whether or not the session should breakpoint at the next opportunity
    
    Returns:
    
    Whether or not the session should breakpoint at the next opportunity
  - setShouldBreakpoint
```
@InternalOnly
public void setShouldBreakpoint(boolean shouldBreakpoint)
```
    Sets whether or not the session should breakpoint at the next opportunity
    
    Parameters:
    
    shouldBreakpoint - Whether or not the session should breakpoint at the next opportunity
  - getStopScrapingCallType
```
@Nullable
public StopScrapingCallType getStopScrapingCallType()
```
    Returns the call type that was issued to initially stop the scraping session
    
    Returns:
    
    The call type initially issued to stop the scraping session, or null if the scrape hasn't been stopped
  - getStopScrapingExplanation
```
@Nullable
public java.lang.String getStopScrapingExplanation()
```
    Returns a string explaining the reason why the scrape was stopped initially. This can be set by developers to help them in their code to determine why they stopped a scraping session from a script
    
    Returns:
    
    The explanation string, or null if none was provided (or the scrape wasn't stopped)
  - shouldStopScraping
```
public boolean shouldStopScraping()
```
    Indicates whether or not the session should stop scraping.
    
    Returns:
    
    A boolean.
  - breakpointIfNeeded
```
public void breakpointIfNeeded()
```
    Breakpoints, if needed.
  - setStopScraping
```
public void setStopScraping(boolean stopScraping)
```
    Sets whether or not the session should stop scraping.
    
    Parameters:
    
    stopScraping - A boolean.
  - setStopScraping
```
public void setStopScraping(boolean forceSet,
                            @Nullable
                            StopScrapingCallType stopScrapingCallType,
                            @Nullable
                            java.lang.String explanation)
```
    Sets whether or not the session should stop scraping.
    
    Parameters:
    
    forceSet - True if this call should update the values even if we are already set to stop, false to only override an unset value
    
    stopScrapingCallType - The type of call issued to stop scraping (or null to indicate nothing -- in which case forceSet must also be true)
    
    explanation - The reason, as a string, why the scrape was stopped. This can be set even if null was passed for the type (which means there is a reason to stop, but no stop has actually been requested)
  - wasStoppedDuringRun
```
@InternalOnly
boolean wasStoppedDuringRun()
```
  - setIsRunning
```
@InternalOnly
public void setIsRunning(boolean isRunning)
```
    Sets whether or not the session is currently running.
    
    Parameters:
    
    isRunning - A boolean.
  - isRunning
```
@InternalOnly
public boolean isRunning()
```
    Indicates whether or not the session is currently running.
    
    Returns:
    
    A boolean.
  - getHasBeenQueued
```
@InternalOnly
public boolean getHasBeenQueued()
```
    Indicates whether or not the scraping session has been queued to be run.
    
    Returns:
    
    A boolean.
  - setHasBeenQueued
```
@InternalOnly
public void setHasBeenQueued(boolean hasBeenQueued)
```
    Sets whether or not the scraping session has been queued to be run.
    
    Parameters:
    
    hasBeenQueued - A boolean.
  - isCompleted
```
@InternalOnly
public boolean isCompleted()
```
    Indicates whether or not the scraper has finished scraping.
    
    Returns:
    
    A boolean.
  - setIsCompleted
```
@InternalOnly
public void setIsCompleted(boolean isCompleted)
```
    Sets whether or not the scraper has finished scraping.
    
    Parameters:
    
    isCompleted - A boolean.
  - setFinishLock
```
@InternalOnly
public void setFinishLock(java.lang.Object finishLock)
```
    Sets the object that should be used to notify external classes when the scraping session finishes.
    
    Parameters:
    
    finishLock - The object to use.
  - getNotifyNotifiableOfCompletion
```
@InternalOnly
public boolean getNotifyNotifiableOfCompletion()
```
    Indicates whether or not the notifiable object should be notified once the scraping session completes. In the case of RunnableScrapingSessions we don't want this to happen or it may also complete the scraping session that spawned it (i.e., if the session object gets passed to the RunnableScrapingSession).
    
    Returns:
    
    A boolean.
  - setNotifyNotifiableOfCompletion
```
@InternalOnly
public void setNotifyNotifiableOfCompletion(boolean notifyNotifiableOfCompletion)
```
    Determines whether or not the notifiable object should be notified once the scraping session completes. In the case of RunnableScrapingSessions we don't want this to happen or it may also complete the scraping session that spawned it (i.e., if the session object gets passed to the RunnableScrapingSession).
    
    Parameters:
    
    notifyNotifiableOfCompletion - A boolean.
  - scrape
```
@InternalOnly
public void scrape()
```
    Required by the RunnableScrapingSession interface. Queues up the session to be run.
  - getTimeout
```
public int getTimeout()
```
    Gets the timeout, in minutes, for the scraping session.
    
    Returns:
    
    The timeout, in minutes.
  - getStartTime
```
public long getStartTime()
```
    Gets the starting time in milliseconds.
    
    Returns:
    
    startTime The starting time in milliseconds.
  - setStartTime
```
public void setStartTime(long startTime)
```
    Sets the starting time to given value which is in milliseconds.
    
    Parameters:
    
    startTime - The starting time in milliseconds.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the timeout, in minutes, for the scraping session.
    
    Parameters:
    
    timeout - The timeout, in minutes.
  - markStopTime
```
@InternalOnly
public void markStopTime()
```
    Marks and sets the point at which the session should stop, if a timeout exists.
  - getElapsedRunningTime
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public long getElapsedRunningTime()
```
    Gets the number of milliseconds that have passed since the scraping session started.
    
    Specified by:
    
    getElapsedRunningTime in interface RunningScrapingSession
    
    Returns:
    
    The number of milliseconds.
  - logElapsedRunningTime
```
@RequiredVersion(value=1)
public void logElapsedRunningTime()
```
    Logs the number of days, hours, minutes, and seconds from the time the scraping session started.
    
    Specified by:
    
    logElapsedRunningTime in interface RunningScrapingSession
  - logCurrentTime
```
@RequiredVersion(value=1)
public void logCurrentTime()
```
    Logs the current time.
    
    Specified by:
    
    logCurrentTime in interface RunningScrapingSession
  - logCurrentDateAndTime
```
@RequiredVersion(value=1)
public void logCurrentDateAndTime()
```
    Logs the current date and time.
    
    Specified by:
    
    logCurrentDateAndTime in interface RunningScrapingSession
  - getFatalErrorOccurred
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public boolean getFatalErrorOccurred()
```
    Gets the flag used to indicate whether or not a fatal error occurred while running this scraping session. This is used in the web interface and to determine whether or not the scraping session should be stopped prematurely.
    
    Specified by:
    
    getFatalErrorOccurred in interface RunningScrapingSession
    
    Returns:
    
    A boolean.
  - setFatalErrorOccurred
```
@RequiredVersion(value=2)
public void setFatalErrorOccurred(boolean fatalErrorOccurred)
```
    Sets the flag used to indicate whether or not a fatal error occurred while running this scraping session. This is used in the web interface and to determine whether or not the scraping session should be stopped prematurely.
    
    Specified by:
    
    setFatalErrorOccurred in interface RunningScrapingSession
    
    Parameters:
    
    fatalErrorOccurred - A boolean.
  - getErrorMessage
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.lang.String getErrorMessage()
```
    Gets the error message that should be persisted to the database once the scraping session ends.
    
    Specified by:
    
    getErrorMessage in interface RunningScrapingSession
    
    Returns:
    
    One or more error messages.
  - getStatusMessage
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.lang.String getStatusMessage()
```
    Gets the status message that should be persisted to the database once the scraping session ends.
    
    Returns:
    
    One or more status messages.
  - setErrorMessage
```
@RequiredVersion(value=2)
public void setErrorMessage(@Nullable
                                                       java.lang.String errorMessage)
```
    Sets the error message that should be persisted to the database once the scraping session ends.
    
    Specified by:
    
    setErrorMessage in interface RunningScrapingSession
    
    Parameters:
    
    errorMessage - The error message to set.
  - setStatusMessage
```
@RequiredVersion(value=2)
public void setStatusMessage(java.lang.String statusMessage)
```
    Sets the status message that should be persisted to the database once the scraping session ends.
    
    Parameters:
    
    statusMessage - The status message to set.
  - appendErrorMessage
```
@RequiredVersion(value=2)
public void appendErrorMessage(java.lang.String errorMessage)
```
    Adds a message to the existing error message(s).
    
    Parameters:
    
    errorMessage - The error message to append.
  - appendStatusMessage
```
@RequiredVersion(value=2)
public void appendStatusMessage(java.lang.String statusMessage)
```
    Adds a message to the existing status message(s).
    
    Parameters:
    
    statusMessage - The status message to append.
  - setNumRecordsScraped
```
@RequiredVersion(value=2)
public void setNumRecordsScraped(java.lang.Object numRecordsScraped)
```
    Sets the number of records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    setNumRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of records scraped. passed in will be added to the current value rather than overwriting it.
  - resetNumRecordsScraped
```
public void resetNumRecordsScraped()
```
    Resets the number of records scraped to 0.
  - addToNumRecordsScraped
```
@RequiredVersion(value=2)
public void addToNumRecordsScraped(java.lang.Object numRecordsScraped)
```
    Adds to the number of records scraped.
    
    Specified by:
    
    addToNumRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of records to add.
  - setNumRecordsScraped
```
public void setNumRecordsScraped(java.lang.Object numRecordsScraped,
                                 boolean addToValue)
```
    Sets the number of records scraped for the primary data set corresponding to this scraping session.
    
    Parameters:
    
    numRecordsScraped - The number of records scraped.
    
    addToValue - If this value is true, the number of records passed in will be added to the current value rather than overwriting it.
  - addToNumRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addToNumRecordsScraped(int numRecordsScraped)
```
    Adds to the number of records scraped.
    
    Specified by:
    
    addToNumRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of records scraped.
  - setNumRecordsScraped
```
public void setNumRecordsScraped(int numRecordsScraped)
```
    Sets the number of records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    setNumRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of records scraped.
  - setNumRecordsScraped
```
public void setNumRecordsScraped(int numRecordsScraped,
                                 boolean addToValue)
```
    Sets the number of records scraped for the primary data set corresponding to this scraping session.
    
    Parameters:
    
    numRecordsScraped - The number of records scraped.
    
    addToValue - If this value is true, the number of records passed in will be added to the current value rather than overwriting it.
  - addToNumNewRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addToNumNewRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Adds to the number of new records scraped.
    
    Specified by:
    
    addToNumNewRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of new records scraped to add.
  - addToNumDuplicateRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addToNumDuplicateRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Adds to the number of duplicate records scraped.
    
    Specified by:
    
    addToNumDuplicateRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of duplicate records scraped to add.
  - addToNumUpdatedRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addToNumUpdatedRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Adds to the number of updated records scraped.
    
    Specified by:
    
    addToNumUpdatedRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of updated records scraped to add.
  - addToNumErrorRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addToNumErrorRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Adds to the number of error records scraped.
    
    Specified by:
    
    addToNumErrorRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of error records scraped to add.
  - setNumNewRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setNumNewRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Sets the number of new records scraped.
    
    Specified by:
    
    setNumNewRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of new records scraped.
  - setNumDuplicateRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setNumDuplicateRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Sets the number of duplicate records scraped.
    
    Specified by:
    
    setNumDuplicateRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of duplicate records scraped.
  - setNumUpdatedRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setNumUpdatedRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Sets the number of duplicate records scraped.
    
    Specified by:
    
    setNumUpdatedRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of duplicate records scraped.
  - setNumErrorRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setNumErrorRecordsScraped(int numRecordsScraped)
```
    Description copied from interface: RunningScrapingSession
    
    Sets the number of error records scraped.
    
    Specified by:
    
    setNumErrorRecordsScraped in interface RunningScrapingSession
    
    Parameters:
    
    numRecordsScraped - The number of error records scraped.
  - getNumNewRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getNumNewRecordsScraped()
```
    Description copied from interface: RunningScrapingSession
    
    Gets the number of new records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    getNumNewRecordsScraped in interface RunningScrapingSession
    
    Returns:
    
    The number of records.
  - getNumDuplicateRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getNumDuplicateRecordsScraped()
```
    Description copied from interface: RunningScrapingSession
    
    Gets the number of duplicate records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    getNumDuplicateRecordsScraped in interface RunningScrapingSession
    
    Returns:
    
    The number of records.
  - getNumUpdatedRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getNumUpdatedRecordsScraped()
```
    Description copied from interface: RunningScrapingSession
    
    Gets the number of duplicate records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    getNumUpdatedRecordsScraped in interface RunningScrapingSession
    
    Returns:
    
    The number of records.
  - getNumErrorRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getNumErrorRecordsScraped()
```
    Description copied from interface: RunningScrapingSession
    
    Gets the number of error records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    getNumErrorRecordsScraped in interface RunningScrapingSession
    
    Returns:
    
    The number of records.
  - getNumRecordsScraped
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getNumRecordsScraped()
```
    Gets the number of records scraped for the primary data set corresponding to this scraping session.
    
    Specified by:
    
    getNumRecordsScraped in interface RunningScrapingSession
    
    Returns:
    
    The number of records.
  - getRelativeTimeThreshold
```
@InternalOnly
public int getRelativeTimeThreshold()
```
    Gets the time threshold to use for the scraping session.
    
    Returns:
    
    The threshold percentage, as an integer.
  - setRelativeTimeThreshold
```
@InternalOnly
public void setRelativeTimeThreshold(int relativeTimeThreshold)
```
    Sets the time threshold to use for the scraping session.
    
    Parameters:
    
    relativeTimeThreshold - The threshold percentage, as an integer.
  - getRelativeRecordsScrapedThreshold
```
@InternalOnly
public int getRelativeRecordsScrapedThreshold()
```
    Gets the records scraped threshold to use for the scraping session.
    
    Returns:
    
    The threshold percentage, as an integer.
  - setRelativeRecordsScrapedThreshold
```
@InternalOnly
public void setRelativeRecordsScrapedThreshold(int relativeRecordsScrapedThreshold)
```
    Sets the records scraped threshold to use for the scraping session.
    
    Parameters:
    
    relativeRecordsScrapedThreshold - The threshold percentage, as an integer.
  - sessionTimedOut
```
@InternalOnly
public boolean sessionTimedOut()
```
    Indicates whether or not the session timed out.
    
    Returns:
    
    A boolean.
  - resetOnCompletion
```
@InternalOnly
public boolean resetOnCompletion()
```
    Indicates whether or not the session should be reset once it completes.
    
    Returns:
    
    A boolean.
  - setResetOnCompletion
```
@InternalOnly
public void setResetOnCompletion(boolean resetOnCompletion)
```
    Determines whether or not the session should be reset once it completes.
    
    Parameters:
    
    resetOnCompletion - A boolean.
  - resetReferers
```
@InternalOnly
public void resetReferers()
```
    Resets the referer for all scrapeable files to null.
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - doExtendedReset
```
@InternalOnly
public void doExtendedReset(boolean nullScrapingSessionNotifiables)
```
    Resets any remaining objects, which external entities querying the scraping session for data may otherwise rely on.
    
    Parameters:
    
    nullScrapingSessionNotifiables - Indicates whether or not the ScrapingSessionNotifiable objects need to be nulled out.
  - clearCustomScriptVariables
```
public void clearCustomScriptVariables()
```
    Clears the custom script variables for this scraping session
    
    Since:
    
    7.0.2a
  - getCustomScriptVariables
```
@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getCustomScriptVariables()
```
    Returns a map of the current script variables. The map can be safely modified as it is a copy of the internal map
    
    Returns:
    
    A map of the current script variables. The map can be safely modified as it is a copy of the internal map
    
    Since:
    
    7.0.2a
  - getCustomScriptVariable
```
@RequiredVersion(value=1)
 @Nullable
public java.lang.Object getCustomScriptVariable(@NotNull
                                                                                       java.lang.String name)
```
    Returns the current value for the given custom script variable
    
    Parameters:
    
    name - The name of the variable
    
    Returns:
    
    The value of the variable, or null if not set
    
    Since:
    
    7.0.2a
  - setCustomScriptVariable
```
@RequiredVersion(value=1)
public void setCustomScriptVariable(@NotNull
                                                               java.lang.String name,
                                                               @Nullable
                                                               java.lang.Object value)
```
    Sets a custom script variable. This is a variable that will be accessible in all scripts run from this scraping session
    
    Parameters:
    
    name - The name of the variable
    
    value - The value of the variable, or null to clear it
    
    Since:
    
    7.0.2a
  - flagAsLoaded
```
@InternalOnly
public void flagAsLoaded()
```
    Flags the scraping session as having been loaded.
  - getMaxHTTPRequests
```
public int getMaxHTTPRequests()
```
    Gets the maximum number of attempts that should be made for each HTTP request.
    
    Returns:
    
    The maximum attempts.
  - setMaxHTTPRequests
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setMaxHTTPRequests(int maxHTTPRequests)
```
    Sets the maximum number of attempts that should be made for each HTTP request.
    
    Parameters:
    
    maxHTTPRequests - The maximum attempts.
  - getExternalProxyUsername
```
@Nullable
public java.lang.String getExternalProxyUsername()
```
    Gets the external proxy username.
    
    Returns:
    
    The username.
  - setExternalProxyUsername
```
public void setExternalProxyUsername(@Nullable
                                     java.lang.String externalProxyUsername)
```
    Sets the external proxy username.
    
    Parameters:
    
    externalProxyUsername - The username.
  - getExternalProxyPassword
```
@Nullable
public java.lang.String getExternalProxyPassword()
```
    Gets the external proxy password.
    
    Returns:
    
    The password.
  - setExternalProxyPassword
```
public void setExternalProxyPassword(@Nullable
                                     java.lang.String externalProxyPassword)
```
    Sets the external proxy password.
    
    Parameters:
    
    externalProxyPassword - The password.
  - getExternalProxyHost
```
@Nullable
public java.lang.String getExternalProxyHost()
```
    Gets the external proxy host.
    
    Returns:
    
    The host.
  - setExternalProxyHost
```
public void setExternalProxyHost(@Nullable
                                 java.lang.String externalProxyHost)
```
    Sets the external proxy host.
    
    Parameters:
    
    externalProxyHost - The host.
  - getExternalProxyPort
```
@Nullable
public java.lang.String getExternalProxyPort()
```
    Gets the external proxy port.
    
    Returns:
    
    The port.
  - setExternalProxyPort
```
public void setExternalProxyPort(@Nullable
                                 java.lang.String externalProxyPort)
```
    Sets the external proxy port.
    
    Parameters:
    
    externalProxyPort - The port.
  - getExternalNTProxyUsername
```
@Nullable
public java.lang.String getExternalNTProxyUsername()
```
    Gets the NT external proxy username.
    
    Returns:
    
    The NT username.
  - setExternalNTProxyUsername
```
public void setExternalNTProxyUsername(@Nullable
                                       java.lang.String externalNTProxyUsername)
```
    Sets the external NT proxy username.
    
    Parameters:
    
    externalNTProxyUsername - The username.
  - getExternalNTProxyPassword
```
@Nullable
public java.lang.String getExternalNTProxyPassword()
```
    Gets the external NT proxy password.
    
    Returns:
    
    The password.
  - setExternalNTProxyPassword
```
public void setExternalNTProxyPassword(@Nullable
                                       java.lang.String externalNTProxyPassword)
```
    Sets the external NT proxy password.
    
    Parameters:
    
    externalNTProxyPassword - The password.
  - getExternalNTProxyHost
```
@Nullable
public java.lang.String getExternalNTProxyHost()
```
    Gets the external NT proxy host.
    
    Returns:
    
    The host.
  - setExternalNTProxyHost
```
public void setExternalNTProxyHost(@Nullable
                                   java.lang.String externalNTProxyHost)
```
    Sets the external NT proxy host.
    
    Parameters:
    
    externalNTProxyHost - The host.
  - getExternalNTProxyDomain
```
@Nullable
public java.lang.String getExternalNTProxyDomain()
```
    Gets the external NT proxy port.
    
    Returns:
    
    The port.
  - setExternalNTProxyDomain
```
public void setExternalNTProxyDomain(@Nullable
                                     java.lang.String externalNTProxyDomain)
```
    Sets the external NT proxy port.
    
    Parameters:
    
    externalNTProxyDomain - The port.
  - getUseStrictMode
```
@InternalOnly
public boolean getUseStrictMode()
```
    Indicates whether or not strict mode should be used.
    
    Returns:
    
    A boolean.
  - setUseStrictMode
```
@InternalOnly
public void setUseStrictMode(boolean useStrictMode)
```
    Determines whether or not strict mode should be used. Note that this is only public because of castor.
    
    Parameters:
    
    useStrictMode - A boolean.
  - getTerminateProxiesOnCompletion
```
public boolean getTerminateProxiesOnCompletion()
```
    Indicates whether or not proxies should be terminated on completion
    
    Returns:
    
    A boolean.
  - setTerminateProxiesOnCompletion
```
public void setTerminateProxiesOnCompletion(boolean terminateProxiesOnCompletion)
```
    Indicates whether or not proxies should be terminated on completion
    
    Parameters:
    
    terminateProxiesOnCompletion - A boolean.
  - getAnonymize
```
public boolean getAnonymize()
```
    Indicates whether or not the scrape should be anonymized
    
    Returns:
    
    A boolean.
  - setAnonymize
```
public void setAnonymize(boolean anonymize)
```
    Indicates whether or not the scrape should be anonymized
    
    Parameters:
    
    anonymize - A boolean.
  - getNumberOfRequiredProxies
```
public int getNumberOfRequiredProxies()
```
    The number of proxies required to anonymize this scraping session
    
    Returns:
    
    A boolean.
  - setNumberOfRequiredProxies
```
public void setNumberOfRequiredProxies(int numberOfRequiredProxies)
```
    The number of proxies required to anonymize this scraping session
    
    Parameters:
    
    numberOfRequiredProxies - An int
  - clearLastRequestsAndResponses
```
@InternalOnly
public void clearLastRequestsAndResponses()
```
    Clears the last request and response for each of the constituent scrapeable files.
  - addXMLFeedItem
```
public void addXMLFeedItem(java.lang.String title,
                           java.lang.String link,
                           java.lang.String description,
                           @Nullable
                           java.util.Date publishedDate)
```
    Adds an XML feed entry to the session.
    
    Parameters:
    
    title - The title for the feed.
    
    link - The link/URL.
    
    description - The description.
    
    publishedDate - The date the feed was published.
  - setUseProxyFromPool
```
public void setUseProxyFromPool(boolean useProxyFromPool)
```
    Sets whether or not a proxy should be used for the current request(s).
    
    Parameters:
    
    useProxyFromPool - A boolean.
  - getUseProxyFromPool
```
public boolean getUseProxyFromPool()
```
    Indicates whether or not a proxy should be used for the current request(s).
    
    Returns:
    
    A boolean.
  - getProxyServerPool
```
@Nullable
public ProxyServerPool getProxyServerPool()
```
    Gets the current ProxyServerPool object, used to cycle through a pool of proxies.
    
    Returns:
    
    A ProxyServerPool object.
  - setProxyServerPool
```
public void setProxyServerPool(@Nullable
                               ProxyServerPool proxyServerPool)
```
    Gets the current ProxyServerPool object, used to cycle through a pool of proxies.
    
    Parameters:
    
    proxyServerPool - The pool
  - getCurrentProxyServerFromPool
```
@Nullable
public ProxyServer getCurrentProxyServerFromPool()
```
    Gets a reference to the current ProxyServer being used from the pool.
    
    Returns:
    
    The ProxyServer.
  - currentProxyServerIsBad
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void currentProxyServerIsBad()
```
    Removes the current ProxyServer from the pool.
  - getNotes
```
@Nullable
 @InternalOnly
public java.lang.String getNotes()
```
    Gets the notes.
    
    Returns:
    
    The notes.
  - setNotes
```
@InternalOnly
public void setNotes(java.lang.String notes)
```
    Sets the notes.
    
    Parameters:
    
    notes - The notes.
  - setLogFileNameAsSessionVariable
```
public void setLogFileNameAsSessionVariable()
```
    Causes the scraping session to set a session variable corresponding to the name of its log file.
  - getLogFileName
```
@Nullable
 @RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.lang.String getLogFileName()
```
    Gets the name of the log file corresponding to this scraping session.
    
    Returns:
    
    The name of the log file.
  - getRetainNonTidiedHTML
```
public boolean getRetainNonTidiedHTML()
```
    Gets whether or not the tidied HTML should be retained for all of the scrapeable files in this session.
    
    Returns:
    
    A boolean.
  - setRetainNonTidiedHTML
```
@RequiredVersion(value=2)
public void setRetainNonTidiedHTML(boolean retainNonTidiedHTML)
```
    Sets whether or not the tidied HTML should be retained for all of the scrapeable files in this session.
    
    Parameters:
    
    retainNonTidiedHTML - A boolean.
  - export
```
@InternalOnly
public void export(@NotNull
                                  java.io.OutputStream outputStream)
                           throws java.lang.Exception
```
    Exports the scraping session to the given stream.
    
    Parameters:
    
    outputStream - The OutputStream the XML will be written to.
    
    Throws:
    
    java.lang.Exception
  - addAllExecuteScriptScriptsToExport
```
@InternalOnly
public void addAllExecuteScriptScriptsToExport()
```
    Adds all execute script scripts that need to be exported by examining each script invoked from within this scraping session for invocations of session.executeScript.
  - getExecuteScriptScriptsToExport
```
@Nullable
 @InternalOnly
public java.util.HashSet getExecuteScriptScriptsToExport()
```
    Gets the set that holds scripts that need to be exported that are called via session.executeScript.
    
    Returns:
    
    A set of Script objects.
  - addExecuteScriptScriptToExport
```
@InternalOnly
public void addExecuteScriptScriptToExport(Script script)
```
    Adds a script to be exported that gets invoked via session.executeScript.
    
    Parameters:
    
    script - The Script to be exported.
  - compareTo
```
@InternalOnly
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.
  - hashCode
```
@InternalOnly
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
@InternalOnly
public boolean equals(@Nullable
                                     java.lang.Object object)
```
    Overriding equals...
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - The object we're comparing.
  - readerPointsToImportableScrapingSession
```
@InternalOnly
public static boolean readerPointsToImportableScrapingSession(@NotNull
                                                                             java.io.Reader reader)
```
    Indicates whether or not the given reader points to an importable scraping session.
    
    Parameters:
    
    reader - A Reader used to reader the characters.
    
    Returns:
    
    A boolean.
  - restoreHTTPParametersAfterScraping
```
public void restoreHTTPParametersAfterScraping()
```
    Indicates that HTTP parameters should be restored after the scraping session finishes scraping.
  - reformatDate
```
@Nullable
 @InternalOnly
public java.lang.String reformatDate(java.lang.String date,
                                                                java.lang.String dateFormatFrom,
                                                                java.lang.String dateFormatTo)
                                                         throws java.lang.Exception
```
    Reformats a date.
    
    Parameters:
    
    date - The date to be formatted, as a string.
    
    dateFormatFrom - The pattern of the existing date.
    
    dateFormatTo - The pattern the date should be converted to.
    
    Returns:
    
    The re-formatted date, if it can be parsed; otherwise, returns the original date.
    
    Throws:
    
    java.text.ParseException - If either of the date formats are invalid.
    
    java.lang.Exception
  - reformatDate
```
@Nullable
 @InternalOnly
public java.lang.String reformatDate(java.lang.String date,
                                                                java.lang.String dateFormatTo)
                                                         throws java.lang.Exception
```
    Reformats a date.
    
    Parameters:
    
    date - The date to be formatted, as a string.
    
    dateFormatTo - The pattern the date should be converted to.
    
    Returns:
    
    The re-formatted date, if it can be parsed; otherwise, returns the original date.
    
    Throws:
    
    java.lang.Exception
  - getOriginatorEdition
```
public int getOriginatorEdition()
```
    Indicates the edition of screen-scraper in which the scraping session was created.
    
    Returns:
    
    The edition, as defined by one of the constants in the Settings class.
  - setOriginatorEdition
```
@InternalOnly
public void setOriginatorEdition(int originatorEdition)
```
    Sets the edition of screen-scraper in which the scraping session was created.
    
    Parameters:
    
    originatorEdition - The edition, as defined by one of the constants in the Settings class.
  - resizeImageFixWidth
```
@InternalOnly
public void resizeImageFixWidth(@NotNull
                                               java.lang.String originalFile,
                                               @NotNull
                                               java.lang.String thumbnailFile,
                                               int newWidthSize,
                                               boolean deleteOriginalFile)
                                        throws java.lang.Exception
```
    Creates a thumbnail for an existing image. If an exception occurs in the process the original file will not be deleted.
    
    Parameters:
    
    originalFile - The path to the original file.
    
    thumbnailFile - The path where the thumbnail should be created.
    
    newWidthSize - The new width of the image.
    
    deleteOriginalFile - Whether or not the original file should be deleted after the thumbnail is created.
    
    Throws:
    
    java.lang.Exception
  - resizeImageFixHeight
```
@InternalOnly
public void resizeImageFixHeight(@NotNull
                                                java.lang.String originalFile,
                                                @NotNull
                                                java.lang.String thumbnailFile,
                                                int newHeightSize,
                                                boolean deleteOriginalFile)
                                         throws java.lang.Exception
```
    Creates a thumbnail for an existing image. If an exception occurs in the process the original file will not be deleted.
    
    Parameters:
    
    originalFile - The path to the original file.
    
    thumbnailFile - The path where the thumbnail should be created.
    
    newHeightSize - The new height of the image.
    
    deleteOriginalFile - Whether or not the original file should be deleted after the thumbnail is created.
    
    Throws:
    
    java.lang.Exception
  - resizeImageFixWidthAndHeight
```
@InternalOnly
public void resizeImageFixWidthAndHeight(@NotNull
                                                        java.lang.String originalFile,
                                                        @NotNull
                                                        java.lang.String thumbnailFile,
                                                        int newWidthSize,
                                                        int newHeightSize,
                                                        boolean deleteOriginalFile)
                                                 throws java.lang.Exception
```
    Creates a thumbnail for an existing image. If an exception occurs in the process the original file will not be deleted.
    
    Parameters:
    
    originalFile - The path to the original file.
    
    thumbnailFile - The path where the thumbnail should be created.
    
    newWidthSize - The new width of the image.
    
    newHeightSize - The new height of the image.
    
    deleteOriginalFile - Whether or not the original file should be deleted after the thumbnail is created.
    
    Throws:
    
    java.lang.Exception
  - getImageHeight
```
@InternalOnly
public int getImageHeight(@NotNull
                                         java.lang.String imagePath)
                                  throws java.lang.Exception
```
    Gets the height of an image.
    
    Parameters:
    
    imagePath - The path to the image.
    
    Returns:
    
    An int, representing the height of the image.
    
    Throws:
    
    java.lang.Exception
  - getImageWidth
```
@InternalOnly
public int getImageWidth(@NotNull
                                        java.lang.String imagePath)
                                 throws java.lang.Exception
```
    Gets the width of an image.
    
    Parameters:
    
    imagePath - The path to the image.
    
    Returns:
    
    An int, representing the width of the image.
    
    Throws:
    
    java.lang.Exception
  - getMemoryUsage
```
@InternalOnly
public int getMemoryUsage()
                                  throws java.lang.Exception
```
    Gets the average memory usage.
    
    Returns:
    
    The memory usage as a whole number percentage.
    
    Throws:
    
    java.lang.Exception
  - logMemoryUsage
```
public void logMemoryUsage()
```
    Logs memory usage for variables and such.
  - getLoggingLevel
```
public int getLoggingLevel()
```
    Gets the logging level to use when running the scraping session.
    
    Returns:
    
    The logging level.
  - setLoggingLevel
```
public void setLoggingLevel(int loggingLevel)
```
    Sets the logging level to use when running the scraping session.
    
    Parameters:
    
    loggingLevel - The logging level.
  - setLoggingLevelDebug
```
public void setLoggingLevelDebug()
```
    Convenience method to set logging level to debug
  - setLoggingLevelInfo
```
public void setLoggingLevelInfo()
```
    Convenience method to set logging level to info
  - setLoggingLevelWarn
```
public void setLoggingLevelWarn()
```
    Convenience method to set logging level to warn
  - setLoggingLevelError
```
public void setLoggingLevelError()
```
    Convenience method to set logging level to error
  - setLoggingLevel
```
@InternalOnly
public void setLoggingLevel(@NotNull
                                           java.lang.String loggingLevel)
```
    Sets the logging level based on a string. Valid values are those found in the Notifiable class.
    
    Parameters:
    
    loggingLevel - A string.
  - getUsesNavigationActions
```
@InternalOnly
public boolean getUsesNavigationActions()
```
    Indicates whether or not any scrapeable files held by this scraping session use navigation actions.
    
    Returns:
    
    A boolean.
  - determineUsesNavigationActions
```
@InternalOnly
public void determineUsesNavigationActions()
```
    Determines and sets whether or not this scraping session uses navigation actions.
  - pushScriptContext
```
@InternalOnly
public void pushScriptContext(ScriptContext scriptContext)
```
    Pushes a ScriptContext object on to the stack.
    
    Specified by:
    
    pushScriptContext in interface RunningScrapingSession
    
    Parameters:
    
    scriptContext - A ScriptContext object.
  - popScriptContext
```
@InternalOnly
public void popScriptContext()
```
    Pops the top ScriptContext object off the stack.
    
    Specified by:
    
    popScriptContext in interface RunningScrapingSession
  - getNumScriptsOnStack
```
public int getNumScriptsOnStack()
```
    Gets the number of ScriptContext objects on the stack.
    
    Specified by:
    
    getNumScriptsOnStack in interface RunningScrapingSession
    
    Returns:
    
    The number.
  - getMaxScriptsOnStack
```
@InternalOnly
public int getMaxScriptsOnStack()
```
    Gets the maximum number of script context objects that can be pushed on to the stack.
    
    Returns:
    
    The number of scripts.
  - setMaxScriptsOnStack
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setMaxScriptsOnStack(int maxScriptsOnStack)
```
    Sets the maximum number of script context objects that can be pushed on to the stack.
    
    Parameters:
    
    maxScriptsOnStack - The number of scripts.
  - getScrapeableSessionID
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getScrapeableSessionID()
```
    When running, this will get the scrapeable session ID.
    
    Returns:
    
    The ID of the scrapeable session.
  - generateScrapeableSession
```
@InternalOnly
public void generateScrapeableSession()
```
    Generates a scrapeable session that will correspond to a running instance of this scraping session.
  - getScrapeableSession
```
@Nullable
 @InternalOnly
public ScrapeableSession getScrapeableSession()
```
    Gets the scrapeable session that corresponds to a running instance of this scraping session. This needs to be accessible at the object level so that the scrapeable session can be created for the scraping session before it actually gets run. For example, if many of these are run via the REST interface the call to run the scraping session would block until the scraping session were actually run otherwise.
    
    Returns:
    
    The ScrapeableSession if it's been created.
  - addChildScrapingSession
```
protected void addChildScrapingSession(ScrapingSession childScrapingSession)
```
    Adds a child ScrapingSession object.
    
    Parameters:
    
    childScrapingSession - The ScrapingSession to add.
  - removeChildScrapingSession
```
protected void removeChildScrapingSession(ScrapingSession childScrapingSession)
```
    Removes a child ScrapingSession object.
    
    Parameters:
    
    childScrapingSession - The ScrapingSession to remove.
  - getParentScrapingSession
```
@Nullable
public ScrapingSession getParentScrapingSession()
```
    If this scraping session was invoked as a RunnableScrapingSession this gets its parent.
    
    Returns:
    
    A ScrapingSession.
  - setParentScrapingSession
```
protected void setParentScrapingSession(ScrapingSession parentScrapingSession)
```
    If this scraping session was invoked as a RunnableScrapingSession this sets its parent.
    
    Parameters:
    
    parentScrapingSession - A ScrapingSession.
  - stopChildScrapingSessions
```
public void stopChildScrapingSessions()
```
    Stops any running scraping session objects.
  - getCharacterSet
```
@Nullable
public java.lang.String getCharacterSet()
```
    Gets the current character set being used.
    
    Returns:
    
    The character set.
  - setCharacterSet
```
public void setCharacterSet(@Nullable
                            java.lang.String characterSet)
```
    Sets the character set to use.
    
    Parameters:
    
    characterSet - The character set.
  - setLastDeterminedCharacterSet
```
@InternalOnly
public void setLastDeterminedCharacterSet(@Nullable
                                                         java.lang.String characterSet)
```
    Sets the last character set determined from a server.
    
    Parameters:
    
    characterSet - The last determined character set from a server, or null if none is known
  - getLastDeterminedCharacterSet
```
@Nullable
public java.lang.String getLastDeterminedCharacterSet()
```
    Gets the last character set determined from a server.
    
    Returns:
    
    The last determined character set from a server, or null if none is known
  - getUseServerCharacterSet
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public boolean getUseServerCharacterSet()
```
    Gets whether the character set indicated by the server should be used.
    
    Returns:
    
    A boolean.
  - setUseServerCharacterSet
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setUseServerCharacterSet(boolean useServerCharacterSet)
```
    Sets whether the character set indicated by the server should be used.
    
    Parameters:
    
    useServerCharacterSet - A boolean.
  - getCharacterSetFromScrapingSessionExportFile
```
@InternalOnly
public static java.lang.String getCharacterSetFromScrapingSessionExportFile(@NotNull
                                                                                           java.io.File file,
                                                                                           @NotNull
                                                                                           java.lang.String charSet)
```
    Determines the character set of the scraping session by examining the contents of its export file.
    
    Parameters:
    
    file - The exported scraping session file.
    
    charSet - The charset to try when reading in the file.
    
    Returns:
    
    The character set, if found; null, otherwise.
  - getCharacterSetFromScrapingSessionExportFile
```
@InternalOnly
public static java.lang.String getCharacterSetFromScrapingSessionExportFile(@NotNull
                                                                                           java.io.File file)
```
    Determines the character set of the scraping session by examining the contents of its export file.
    
    Parameters:
    
    file - The exported scraping session file.
    
    Returns:
    
    The character set, if found; null, otherwise.
  - getDateExported
```
@Nullable
public java.lang.String getDateExported()
```
    Gets the date the scraping session was exported.
    
    Returns:
    
    The date as a string.
  - setDateExported
```
@InternalOnly
public void setDateExported(java.lang.String date)
```
    Sets the date the scraping session was exported.
    
    Parameters:
    
    date - The date as a string.
  - getDateUpdated
```
public long getDateUpdated()
```
    Gets the last time the scraping session was updated.
    
    Returns:
    
    A long.
  - setDateUpdated
```
@InternalOnly
public void setDateUpdated(long dateUpdated)
```
    Sets the last time the scraping session was updated.
    
    Parameters:
    
    dateUpdated - A long.
  - getNeedsToBeSaved
```
@InternalOnly
public boolean getNeedsToBeSaved()
```
    Indicates whether or not the object needs to be saved.
    
    Returns:
    
    A boolean.
  - setNeedsToBeSaved
```
@InternalOnly
public void setNeedsToBeSaved(boolean needsToBeSaved)
```
    Sets whether or not the object needs to be saved.
    
    Parameters:
    
    needsToBeSaved - A boolean.
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Gets the connection timeout to use.
    
    Returns:
    
    The connection timeout. If this value hasn't been set the default timeout will be used.
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    Sets the connection timeout to use.
    
    Parameters:
    
    connectionTimeout - The connection timeout in seconds.
  - getKeyStoreFilePath
```
@Nullable
public java.lang.String getKeyStoreFilePath()
```
    Gets the path to the keystore file.
    
    Returns:
    
    The path to the keystore file.
  - setKeyStoreFilePath
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setKeyStoreFilePath(java.lang.String keyStoreFilePath)
```
    Sets the path to the keystore file.
    
    Parameters:
    
    keyStoreFilePath - The path to the keystore file.
  - getKeyStorePassword
```
@Nullable
public java.lang.String getKeyStorePassword()
```
    Gets the password to be used for the key store file.
    
    Returns:
    
    The keystore password.
  - setKeyStorePassword
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setKeyStorePassword(java.lang.String keyStorePassword)
```
    Sets the password to be used for the key store file.
  - getRandomizeUserAgent
```
public boolean getRandomizeUserAgent()
```
    Indicates whether or not the user agent should be randomized.
    
    Returns:
    
    A boolean.
  - setRandomizeUserAgent
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setRandomizeUserAgent(boolean randomizeUserAgent)
```
    Sets whether or not the user agent should be randomized.
    
    Parameters:
    
    randomizeUserAgent - A boolean.
  - getUserAgent
```
@Nullable
public java.lang.String getUserAgent()
```
    Gets the user-agent to be used in HTTP requests.
    
    Returns:
    
    The user-agent.
  - setUserAgent
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setUserAgent(@Nullable
                                                                                                                           java.lang.String userAgent)
```
    Sets the user-agent to be used in HTTP requests.
    
    Parameters:
    
    userAgent - The user-agent.
  - getDefaultUserAgent
```
@NotNull
public java.lang.String getDefaultUserAgent()
```
    Gets the default user agent.
    
    Returns:
    
    The user agent.
  - setDefaultUserAgent
```
public void setDefaultUserAgent(java.lang.String defaultUserAgent)
```
    Sets the default user agent.
    
    Parameters:
    
    defaultUserAgent - The default user agent.
  - getDataToSendToClientAsArrayAndFlush
```
@NotNull
 @InternalOnly
public java.lang.Object[] getDataToSendToClientAsArrayAndFlush()
```
    Gets the data to be sent to the client as a raw array of HashMap objects, then flushes out all of the data from the array list.
    
    Returns:
    
    An array of two-dimensional array objects.
  - sendDataToClient
```
@RequiredVersion(value=2)
public void sendDataToClient(@Nullable
                                                        java.lang.String key,
                                                        @Nullable
                                                        java.lang.Object value)
```
    Queues up an element of data to be sent to a client.
    
    Specified by:
    
    sendDataToClient in interface RunningScrapingSession
    
    Parameters:
    
    key - The key identifier of the data.
    
    value - The value portion of the data.
  - isDataFlavorSupported
```
@InternalOnly
public boolean isDataFlavorSupported(@NotNull
                                                    java.awt.datatransfer.DataFlavor df)
```
    ************************************************** Transferable methods. **************************************************
    
    Specified by:
    
    isDataFlavorSupported in interface java.awt.datatransfer.Transferable
  - getTransferData
```
@NotNull
 @InternalOnly
public java.lang.Object getTransferData(@NotNull
                                                                  java.awt.datatransfer.DataFlavor df)
                                                           throws java.awt.datatransfer.UnsupportedFlavorException
```
    Specified by:
    
    getTransferData in interface java.awt.datatransfer.Transferable
    
    Throws:
    
    java.awt.datatransfer.UnsupportedFlavorException
  - getTransferDataFlavors
```
@NotNull
 @InternalOnly
public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
```
    Specified by:
    
    getTransferDataFlavors in interface java.awt.datatransfer.Transferable
  - dumpToLog
```
@InternalOnly
public void dumpToLog()
```
    Dumps the session to the log.
  - setTimeZone
```
public void setTimeZone(@Nullable
                        java.lang.String timeZone)
```
    Sets the time zone that will be used when using a method that returns a time formatted as a string, but doesn't take a time.
    
    Parameters:
    
    timeZone - The new timezone to use. If null is given, the local timezone will be used.
  - setTimeZone
```
public void setTimeZone(@Nullable
                        java.util.TimeZone timeZone)
```
    Sets the time zone that will be used when using a method that returns a time formatted as a string, but doesn't take a time.
    
    Parameters:
    
    timeZone - The new timezone to use. If null is given, the local timezone will be used.
  - getTimeZone
```
@Nullable
public java.util.TimeZone getTimeZone()
```
    Gets the current time zone of the Scraping Session
    
    Returns:
    
    The time zone this scrape is set to
  - isRunningInWorkbench
```
public boolean isRunningInWorkbench()
```
    Returns whether or not we are currently running in the workbench. This is a convenience method for doing something different in a script when running in the workbench as opposed to the other modes.
    
    Returns:
    
    True iff the scrape is currently running in the workbench
  - isRunningFromCommandLine
```
public boolean isRunningFromCommandLine()
```
    Returns whether or not we are currently running from the command line. This is a convenience method for doing something different in a script when running from the command line as opposed to the other modes.
    
    Returns:
    
    True iff the scrape is currently running from the command line
  - isRunningInServer
```
public boolean isRunningInServer()
```
    Returns whether or not we are currently running in server mode. This is a convenience method for doing something different in a script when running in server mode as opposed to the other modes.
    
    Returns:
    
    True iff the scrape is currently running in server mode
  - getDebugMode
```
public boolean getDebugMode()
```
    Checks to see if this is currently set to run in debug mode
    
    Returns:
    
    True if debug mode is enabled
  - setDebugMode
```
public void setDebugMode(boolean debugMode)
```
    Sets the debug state for the scrape. Enabled debug mode simply outputs a warning periodically while running, to help prevent running a production scrape in debug mode.
    
    Parameters:
    
    debugMode - True to enable debug mode.
  - setVariables
```
public void setVariables(@NotNull
                         java.util.Map<java.lang.Object,java.lang.Object> variables)
```
    Sets the value of all session variables that that match the keys in the Map to the values in the Map. This will ignore a key of DATARECORD
    
    Parameters:
    
    variables - The map to use when setting the session variables
  - setVariables
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setVariables(@NotNull
                                                                                                                           java.util.Map<java.lang.Object,java.lang.Object> variables,
                                                                                                                           boolean ignoreLowerCaseKeys)
```
    Sets the value of all session variables that that match the keys in the Map to the values in the Map. This will ignore a key of DATARECORD
    
    Parameters:
    
    variables - The map to use when setting the session variables
    
    ignoreLowerCaseKeys - True if keys with lowercase characters should be ignored
  - setSessionVariablesFromMap
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setSessionVariablesFromMap(@NotNull
                                                                                                                                         java.util.Map<java.lang.Object,java.lang.Object> map,
                                                                                                                                         boolean ignoreLowerCaseKeys)
```
    Sets the value of all session variables that that match the keys in the Map to the values in the Map. This will ignore a key of DATARECORD
    
    Parameters:
    
    map - The map to use when setting the session variables
    
    ignoreLowerCaseKeys - True if keys with lowercase characters should be ignored
  - clearVariables
```
public void clearVariables(@NotNull
                           java.util.Map<java.lang.Object,java.lang.Object> variables)
```
    Clears the value of all session variables that that match the keys in the Map
    
    Parameters:
    
    variables - The variables to clear in the session
  - clearVariables
```
public void clearVariables(@NotNull
                           java.util.Collection<java.lang.Object> variables)
```
    Clears the value of all session variables that that match the values in the collection
    
    Parameters:
    
    variables - The variables to clear in the session
  - removeSessionVariablesInMap
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void removeSessionVariablesInMap(@NotNull
                                                                                                                                          java.util.Map<java.lang.Object,java.lang.Object> variables,
                                                                                                                                          boolean ignoreLowerCaseKeys)
```
    Clears the value of all session variables that that match the keys in the Map
    
    Parameters:
    
    variables - The map to use when clearing the keys from the session
    
    ignoreLowerCaseKeys - True if keys with lowercase characters should be ignored
  - getLastImportTime
```
public java.util.Date getLastImportTime()
```
    In workbench mode returns the current time, otherwise returns the last time a scrape with this name was imported (or if it hasn't been imported since the instance was started will return the instance start time)
    
    Returns:
    
    The last time the scrape was imported
  - getScrapeLogger
```
@NotNull
 @InternalOnly
public ScrapeStateLogger getScrapeLogger()
```
    Gets the ScrapeStateLogger that is currently holding monitored variable names, etc... This method shouldn't need to be used except internally when duplicating a session.
    
    Returns:
    
    The ScrapeStateLogger used by this session
  - addMonitoredValue
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.lang.Object addMonitoredValue(java.lang.String name,
                                                                                                                                            java.lang.Object value)
```
    Adds a specific name and value to be logged with the web messages methods or logMonitoredValues method
    
    Parameters:
    
    name - The name for the value being monitored
    
    value - The value to associate with the given name
    
    Returns:
    
    The previous value associated with the name, or null if there wasn't one
  - removeMonitoredValue
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.lang.Object removeMonitoredValue(java.lang.String name)
```
    Removes a specific name from the manually set values to be logged. Doesn't affect the value of session variables
    
    Parameters:
    
    name - The name for the value to remove
    
    Returns:
    
    The previous value associated with the name, or null if there wasn't one
  - addMonitoredVariable
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addMonitoredVariable(java.lang.String key)
```
    Watches the value of a session variable, and will output it each time monitored variables are output
    
    Parameters:
    
    key - The key in the session corresponding to a value
  - addMonitoredPrefix
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addMonitoredPrefix(java.lang.String prefix)
```
    Watches for all session variables whose keys begin with the prefix specified, and will output their values when monitored variables are logged.
    
    Parameters:
    
    prefix - The prefix to monitor
  - addMonitoredPostfix
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addMonitoredPostfix(java.lang.String postfix)
```
    Watches for all session variables whose keys end with the postfix specified, and will output their values when monitored variables are logged.
    
    Parameters:
    
    postfix - The postfix to monitor
  - removeMonitoredVariable
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void removeMonitoredVariable(java.lang.String key)
```
    Stops watching the specified variable
    
    Parameters:
    
    key - Key for the variable to stop watching
  - removeMonitoredPrefix
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void removeMonitoredPrefix(java.lang.String prefix)
```
    Stops watching for a prefix in session variables
    
    Parameters:
    
    prefix - Prefix to remove from monitoring
  - removeMonitoredPostfix
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void removeMonitoredPostfix(java.lang.String postfix)
```
    Stops watching for a postfix in session variables
    
    Parameters:
    
    postfix - Postfix to remove from monitoring
  - logMonitoredValues
```
public void logMonitoredValues(java.lang.Object message)
                        throws java.lang.Exception
```
    Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top. Also logs any additional values being watched. Logs values at the debug level.
    
    Parameters:
    
    message - A message to output as a header for this log entry
    
    Throws:
    
    java.lang.Exception
  - logMonitoredValues
```
@InternalOnly
public void logMonitoredValues(java.lang.Object message,
                                              int logLevel)
```
    Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top. Also logs any additional values being watched. Logs values at the specified level.
    
    Parameters:
    
    message - A message to output as a header for this log entry
    
    logLevel - The level to log at
  - logMonitoredValuesDebug
```
@RequiredVersion(value=1)
public void logMonitoredValuesDebug(java.lang.Object message)
```
    Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top. Also logs any additional values being watched. Logs values at the debug level.
    
    Parameters:
    
    message - A message to output as a header for this log entry
  - logMonitoredValuesInfo
```
@RequiredVersion(value=1)
public void logMonitoredValuesInfo(java.lang.Object message)
```
    Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top. Also logs any additional values being watched. Logs values at the info level.
    
    Parameters:
    
    message - A message to output as a header for this log entry
  - logMonitoredValuesWarn
```
@RequiredVersion(value=1)
public void logMonitoredValuesWarn(java.lang.Object message)
```
    Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top. Also logs any additional values being watched. Logs values at the warn level.
    
    Parameters:
    
    message - A message to output as a header for this log entry
  - logMonitoredValuesError
```
@RequiredVersion(value=1)
public void logMonitoredValuesError(java.lang.Object message)
```
    Logs the values of all the currently monitored variables, the progress of the scrape, if known, and puts the message at the top. Also logs any additional values being watched. Logs values at the error level.
    
    Parameters:
    
    message - A message to output as a header for this log entry
  - logMonitoredValuesClose
```
@RequiredVersion(value=1)
public void logMonitoredValuesClose(java.lang.Object message)
```
    Logs closing values to indicate the scrape is complete and what values were when everything finished. It will log at whatever the highest level logged to was. For instance, if a webWarn had been logged during the scrape, this will log at the warning level.
    
    Parameters:
    
    message - The message to display as a header
  - logDataRecord
```
public void logDataRecord(DataRecord record)
```
    Logs all the values in a Data Record to the log, with one line per value. If a value in the record is a List, Set, Map, Data Set, Scrapeable File, or Exception, it will have detailed output as well. Logs at the current scraping session log level.
    
    Parameters:
    
    record - The DataRecord to write to the log
  - logDataRecord
```
@InternalOnly
public void logDataRecord(DataRecord record,
                                         int logLevel)
```
    Logs all the values in a Data Record to the log, with one line per value. If a value in the record is a List, Set, Map, Data Set, Scrapeable File, or Exception, it will have detailed output as well.
    
    Parameters:
    
    record - The DataRecord to write to the log
    
    logLevel - The level to log the data record at, as an int
  - logDataRecordDebug
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logDataRecordDebug(DataRecord record)
```
    Logs a DataRecord at the Debug level
    
    Parameters:
    
    record - The DataRecord to log
  - logDataRecordInfo
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logDataRecordInfo(DataRecord record)
```
    Logs a DataRecord at the Info level
    
    Parameters:
    
    record - The DataRecord to log
  - logDataRecordWarn
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logDataRecordWarn(DataRecord record)
```
    Logs a DataRecord at the Warn level
    
    Parameters:
    
    record - The DataRecord to log
  - logDataRecordError
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logDataRecordError(DataRecord record)
```
    Logs a DataRecord at the Error level
    
    Parameters:
    
    record - The DataRecord to log
  - logException
```
public void logException(java.lang.Throwable exception)
```
    Logs an Exception, with a full stack trace
    
    Parameters:
    
    exception - The Exception to log
  - logObjectByType
```
public void logObjectByType(java.lang.Object object)
```
    Logs the Object in a semi intelligent way. For example, Maps are logged as key-value pairs, lists are logged with one element per line, all elements of a set are logged, etc... Some objects will just log their value using String.valueOf() if it isn't a standard type of data set/list Logs at the current scraping session log level.
    
    Parameters:
    
    object - The Object to write to the log
  - logObjectByType
```
@InternalOnly
public void logObjectByType(java.lang.Object object,
                                           int logLevel)
```
    Logs the Object in a semi intelligent way. For example, Maps are logged as key-value pairs, lists are logged with one element per line, all elements of a set are logged, etc... Some objects will just log their value using String.valueOf() if it isn't a standard type of data set/list
    
    Parameters:
    
    object - The Object to write to the log
    
    logLevel - The level to log the data record at, as an int
  - logObjectByTypeDebug
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logObjectByTypeDebug(java.lang.Object object)
```
    Logs the Object in a semi intelligent way. For example, Maps are logged as key-value pairs, lists are logged with one element per line, all elements of a set are logged, etc... Some objects will just log their value using String.valueOf() if it isn't a standard type of data set/list Logs at the Debug level.
    
    Parameters:
    
    object - The Object to write to the log
  - logObjectByTypeInfo
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logObjectByTypeInfo(java.lang.Object object)
```
    Logs the Object in a semi intelligent way. For example, Maps are logged as key-value pairs, lists are logged with one element per line, all elements of a set are logged, etc... Some objects will just log their value using String.valueOf() if it isn't a standard type of data set/list Logs at the Info level.
    
    Parameters:
    
    object - The Object to write to the log
  - logObjectByTypeWarn
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logObjectByTypeWarn(java.lang.Object object)
```
    Logs the Object in a semi intelligent way. For example, Maps are logged as key-value pairs, lists are logged with one element per line, all elements of a set are logged, etc... Some objects will just log their value using String.valueOf() if it isn't a standard type of data set/list Logs at the Warn level.
    
    Parameters:
    
    object - The Object to write to the log
  - logObjectByTypeError
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void logObjectByTypeError(java.lang.Object object)
```
    Logs the Object in a semi intelligent way. For example, Maps are logged as key-value pairs, lists are logged with one element per line, all elements of a set are logged, etc... Some objects will just log their value using String.valueOf() if it isn't a standard type of data set/list Logs at the Error level.
    
    Parameters:
    
    object - The Object to write to the log
  - webDebug
```
@RequiredVersion(value=1)
public void webDebug(java.lang.Object message)
```
    Logs a debug message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
  - webDebug
```
@RequiredVersion(value=1)
public void webDebug(java.lang.Object message,
                                                java.lang.Object loggable)
```
    Logs a debug message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webDebug
```
@RequiredVersion(value=1)
public void webDebug(java.lang.Object message,
                                                boolean saveMessage)
```
    Logs a debug message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
  - webDebug
```
@RequiredVersion(value=1)
public void webDebug(java.lang.Object message,
                                                boolean saveMessage,
                                                @Nullable
                                                java.lang.Object loggable)
```
    Logs a debug message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webInfo
```
@RequiredVersion(value=1)
public void webInfo(java.lang.Object message)
```
    Logs an info message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
  - webInfo
```
@RequiredVersion(value=1)
public void webInfo(java.lang.Object message,
                                               java.lang.Object loggable)
```
    Logs an info message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webInfo
```
@RequiredVersion(value=1)
public void webInfo(java.lang.Object message,
                                               boolean saveMessage)
```
    Logs an info message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
  - webInfo
```
@RequiredVersion(value=1)
public void webInfo(java.lang.Object message,
                                               boolean saveMessage,
                                               @Nullable
                                               java.lang.Object loggable)
```
    Logs an info message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webWarn
```
@RequiredVersion(value=1)
public void webWarn(java.lang.Object message)
```
    Logs a warn message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
  - webWarn
```
@RequiredVersion(value=1)
public void webWarn(java.lang.Object message,
                                               java.lang.Object loggable)
```
    Logs a warn message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webWarn
```
@RequiredVersion(value=1)
public void webWarn(java.lang.Object message,
                                               boolean saveMessage)
```
    Logs a warn message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
  - webWarn
```
@RequiredVersion(value=1)
public void webWarn(java.lang.Object message,
                                               boolean saveMessage,
                                               @Nullable
                                               java.lang.Object loggable)
```
    Logs a warn message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webError
```
@RequiredVersion(value=1)
public void webError(java.lang.Object message)
```
    Logs an error message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
  - webError
```
@RequiredVersion(value=1)
public void webError(java.lang.Object message,
                                                java.lang.Object loggable)
```
    Logs an error message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webError
```
@RequiredVersion(value=1)
public void webError(java.lang.Object message,
                                                boolean saveMessage)
```
    Logs an error message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
  - webError
```
@RequiredVersion(value=1)
public void webError(java.lang.Object message,
                                                boolean saveMessage,
                                                @Nullable
                                                java.lang.Object loggable)
```
    Logs an error message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    saveMessage - Whether or not to save this message and continue to display it below future messages
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - webClose
```
@RequiredVersion(value=1)
public void webClose(java.lang.Object message)
```
    Logs closing values to indicate the scrape is complete and what values were when everything finished. It will log at whatever the highest level logged to was. For instance, if a webWarn had been logged during the scrape, this will log at the warning level.
    
    Parameters:
    
    message - The message to display as a header
  - webClose
```
@RequiredVersion(value=1)
public void webClose(java.lang.Object message,
                                                @Nullable
                                                java.lang.Object loggable)
```
    Logs an error message to the web interface error message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log.
    
    Parameters:
    
    message - The message to display as a header
    
    loggable - An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values
  - logScreenScraperInformation
```
public void logScreenScraperInformation()
```
    Logs useful information about the current instance of Screen-Scraper, as well as the Java VM and the General Utility version being used. Information will be logged as an info message.
  - addProgressBar
```
@NotNull
 @RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public ProgressBar addProgressBar(java.lang.String title)
```
    Adds a new progress bar with the given title
    
    Parameters:
    
    title - The title for the new progress bar
    
    Returns:
    
    The new progress bar
  - addProgressBar
```
@NotNull
 @RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public ProgressBar addProgressBar(java.lang.String title,
                                                                                                                                               @NotNull
                                                                                                                                               java.lang.String total)
```
    Adds a new progress bar with the given title and total
    
    Parameters:
    
    title - The title for the new progress bar
    
    total - The total for the new progress bar
    
    Returns:
    
    The new progress bar
    
    Throws:
    
    java.lang.NumberFormatException - total isn't parseable as a Double
  - addProgressBar
```
@NotNull
 @RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public ProgressBar addProgressBar(java.lang.String title,
                                                                                                                                               double total)
```
    Adds a new progress bar with the given title and total
    
    Parameters:
    
    title - The title for the new progress bar
    
    total - The total for the new progress bar
    
    Returns:
    
    The new progress bar
  - removeProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void removeProgressBar(ProgressBar progressBar)
```
    Removes the specified progress bar
    
    Parameters:
    
    progressBar - The ProgressBar to remove
  - getProgressBar
```
@Nullable
 @RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public ProgressBar getProgressBar(int index)
```
    Returns the progress bar at the given index, with 0 being the highest level bar, and lower-level bars being sequentially larger in index
    
    Parameters:
    
    index - The desired ProgressBar's index
    
    Returns:
    
    The ProgressBar at the given index, or null if the index is out of range
  - getProgressBar
```
@Nullable
 @RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public ProgressBar getProgressBar(java.lang.String title)
```
    Returns the first progress bar with the given title, or null if none is found. Starts with the lowest level progress bar (most recently added)
    
    Parameters:
    
    title - The title to search for
    
    Returns:
    
    The lowest-level progress bar (most recently added) with the specified title, or null if no such bar exists
  - getNumProgressBars
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public int getNumProgressBars()
```
    Returns the current number of progress bars
    
    Returns:
    
    The number of progress bars
  - getLastProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public ProgressBar getLastProgressBar()
```
    Returns the last progress bar
    
    Returns:
    
    The last progress bar that was added
  - unlockBreakpointBlockedThreads
```
void unlockBreakpointBlockedThreads()
```
    This should be called at the end of the scrape. It opens the breakpoint gate so anything that was locked on a breakpoint will be allowed to continue
  - resetThreadGate
```
void resetThreadGate()
```
    Resets the state of the thread gate so it is ready for a new scrape to run
  - resetCallbacks
```
void resetCallbacks()
```
  - waitForBreakpoint
```
public void waitForBreakpoint()
```
    Waits for a breakpoint in the workbench. Useful for external classes to pause what they are logging or doing when a breakpoint is triggered (usually via the breakpoint button)
  - waitForBreakpoint
```
@Deprecated
 @InternalOnly
public void waitForBreakpoint(boolean pauseBackgroundThreads)
```
    Deprecated. pauseBackgroundThreads was causing some locking issues, so it is now ignored
    
    Waits for a breakpoint in the workbench. Useful for external classes to pause what they are logging or doing when a breakpoint is triggered (usually via the breakpoint button). Can be set to allow background threads that call this method to keep running anyway
    
    Parameters:
    
    pauseBackgroundThreads - Should background threads calling this method continue running anyway.
  - getScrapeCache
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
 @Nullable
public FileCacher getScrapeCache()
```
    Returns the scrape cacher object used to cache data about the scrape
    
    Returns:
    
    The current scrape cacher
    
    Since:
    
    7.0.4a
  - getUsableScrapeCache
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
 @Nullable
public FileCacher getUsableScrapeCache()
```
    Returns the scrape cacher object used to cache data about the scrape, or the parent scrapes if this scrape has a parent but not a cacher
    
    Returns:
    
    The current scrape cacher
    
    Since:
    
    7.0.4a
  - setScrapeCacher
```
void setScrapeCacher(@Nullable
                     FileCacher cacher)
```
    Sets the cacher that will be used for this session. This will not set it in a way that will close the cache when the scrape ends.
    
    Parameters:
    
    cacher - The new cacher to use. Null values do not clear a cacher if one already exists.
  - enableCaching
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void enableCaching(java.lang.String description,
                                                                                                                            boolean saveLogs,
                                                                                                                            boolean zipCachedFiles)
```
    Enables caching for this scrape. When caching is enabled, each time a scrapeable file is downloaded it will be cached. Once the session is completed the cache will be either zipped or the directory renamed, depending on the conditions that were specified when the cache was enabled. Optionally this will save the log files to the cached location, and will save everything from the error.log file that was added while the cache was enabled.
    
    Parameters:
    
    description - A description to use in the cached file name
    
    saveLogs - True if logs should be included in the cache
    
    zipCachedFiles - True if the cached files should be zipped once the scrape ends.
  - endCachingAtScrapeClose
```
@InternalOnly
public void endCachingAtScrapeClose()
                                            throws java.io.IOException
```
    Ends the cache for the scrape. This method should be called internally at the end of a scrape
    
    Throws:
    
    java.io.IOException - If there was an error writing the zip or renaming the cache directory
  - endCaching
```
@Nullable
 @RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.io.File endCaching()
                                                                                                                                      throws java.io.IOException
```
    Ends the cache for the scrape. This method will be called once all the scripts and files are run/scraped. It can be called in a script to end the cache early (thereby only caching a portion of the scrape).
    
    Returns:
    
    The File representing either the zipped file or the root directory of the cache, depending on whether the cache was to zip the files or not
    
    Throws:
    
    java.io.IOException - If there was an error writing the zip or renaming the cache directory
  - getCachingEnabled
```
public boolean getCachingEnabled()
```
    Returns whether or not the cache is enabled for the scrape
    
    Returns:
    
    True if caching should occur
  - cacheBytes
```
@Nullable
public java.io.File cacheBytes(java.lang.String outputFilenameAndPath,
                                          byte[] bytes)
```
    Adds a file to the cache from bytes.
    
    Parameters:
    
    outputFilenameAndPath - The name of the file in the cache, including any directory it should be placed in
    
    bytes - The content of the file that should be cached.
    
    Returns:
    
    A File that represents the cached file.
    
    Throws:
    
    java.io.IOException - If there is an error writing the bytes to the cache directory for the scrape
    
    Since:
    
    7.0.9a
  - cacheFile
```
@Nullable
public java.io.File cacheFile(java.lang.String outputFilenameAndPath,
                                         java.io.File fileToCache)
```
    Adds a file to the cache. This can be used to add anything to the cache, from a text file to an image that was downloaded, or any other file that would be useful.
    
    Parameters:
    
    outputFilenameAndPath - The name of the file in the cache, including any directory it should be placed in
    
    fileToCache - The file that should be cached. This cannot be a directory
    
    Returns:
    
    A File that represents the cached file.
    
    Throws:
    
    java.io.IOException - If there is an error copying the file to the new location.
  - cacheText
```
@Nullable
public java.io.File cacheText(java.lang.String name,
                                         java.lang.String content)
                                  throws java.io.IOException
```
    Adds text to the cache. This will create a new text file in the cache and store the given content in it.
    
    Parameters:
    
    name - The name for the file containing the cached text. This can include a path
    
    content - The content to place in the cache
    
    Returns:
    
    A File representing the file in the cache containing the text
    
    Throws:
    
    java.io.IOException - When there is a problem caching the text to a file
  - cacheText
```
@Nullable
public java.io.File cacheText(java.lang.String name,
                                         java.lang.String content,
                                         @Nullable
                                         java.lang.String encoding)
```
    Adds text to the cache. This will create a new text file in the cache and store the given content in it.
    
    Parameters:
    
    name - The name for the file containing the cached text. This can include a path
    
    content - The content to place in the cache
    
    encoding - The encoding to use for the text, or null to use the default encoding for Java
    
    Returns:
    
    A File representing the file in the cache containing the text
    
    Throws:
    
    java.io.IOException - When there is a problem caching the text to a file
  - cacheScrapeableFile
```
@Nullable
public java.io.File cacheScrapeableFile(@NotNull
                                                   ScrapeableFile scrapeableFile)
                                            throws java.io.IOException
```
    Caches the HTML and headers of the scrapeable file
    
    Parameters:
    
    scrapeableFile - The file to cache
    
    Returns:
    
    Returns a file representing the cached file. This is the file saved in the temp cache directory. Modifying it or deleting it will modify/remove it from the eventual cache file.
    
    Throws:
    
    java.io.IOException - When failure occurs writing the file to disk
  - addAutoProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addAutoProgressBar(java.lang.String name,
                                                                                                                                 java.lang.String... values)
```
    Creates an automatic progress bar and adds it to the progress bars. These progress bars match their progress to a value from a session variable and a list of values. Note that when using auto progress bars, it is advised to not use any manually monitored ones, as it can cause conflicts. Anytime an auto progress bar has no session variable set for its monitored key, it deletes itself and all children progress bars (including manual ones). As long as you keep that in mind, it should be safe to use both types together.
    
    Parameters:
    
    name - The name of the progress bar, which should match the session variable where the value for updating this bar will be stored
    
    values - The values this progress bar can have, in the order they will be queried
  - addAutoProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addAutoProgressBar(java.lang.String name,
                                                                                                                                 @NotNull
                                                                                                                                 java.lang.String[][] values)
```
    Creates an automatic progress bar and adds it to the progress bars. These progress bars match their progress to a value from a session variable and a list of values. Note that when using auto progress bars, it is advised to not use any manually monitored ones, as it can cause conflicts. Anytime an auto progress bar has no session variable set for its monitored key, it deletes itself and all children progress bars (including manual ones). As long as you keep that in mind, it should be safe to use both types together.
    
    Parameters:
    
    name - The name of the progress bar, which should match the session variable where the value for updating this bar will be stored
    
    values - The values this progress bar can have, in the order they will be queried
  - addAutoProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addAutoProgressBar(java.lang.String name,
                                                                                                                                 @NotNull
                                                                                                                                 java.lang.String[][] values,
                                                                                                                                 int keyIndex)
```
    Creates an automatic progress bar and adds it to the progress bars. These progress bars match their progress to a value from a session variable and a list of values. Note that when using auto progress bars, it is advised to not use any manually monitored ones, as it can cause conflicts. Anytime an auto progress bar has no session variable set for its monitored key, it deletes itself and all children progress bars (including manual ones). As long as you keep that in mind, it should be safe to use both types together.
    
    Parameters:
    
    name - The name of the progress bar, which should match the session variable where the value for updating this bar will be stored
    
    values - The values this progress bar can have, in the order they will be queried
    
    keyIndex - The index in each inner array of the value that will be set in the session variable
  - addAutoProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addAutoProgressBar(java.lang.String name,
                                                                                                                                 @NotNull
                                                                                                                                 java.util.Collection<java.lang.String> values)
```
    Creates an automatic progress bar and adds it to the progress bars. These progress bars match their progress to a value from a session variable and a list of values. Note that when using auto progress bars, it is advised to not use any manually monitored ones, as it can cause conflicts. Anytime an auto progress bar has no session variable set for its monitored key, it deletes itself and all children progress bars (including manual ones). As long as you keep that in mind, it should be safe to use both types together.
    
    Parameters:
    
    name - The name of the progress bar, which should match the session variable where the value for updating this bar will be stored
    
    values - The values this progress bar can have, in the order they will be queried
  - addAutoProgressBar
```
@RequiredVersion(value=2,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void addAutoProgressBar(java.lang.String name,
                                                                                                                                 @NotNull
                                                                                                                                 DataSet values,
                                                                                                                                 @NotNull
                                                                                                                                 java.lang.String key)
```
    Creates an automatic progress bar and adds it to the progress bars. These progress bars match their progress to a value from a session variable and a list of values. Note that when using auto progress bars, it is advised to not use any manually monitored ones, as it can cause conflicts. Anytime an auto progress bar has no session variable set for its monitored key, it deletes itself and all children progress bars (including manual ones). As long as you keep that in mind, it should be safe to use both types together.
    
    Parameters:
    
    name - The name of the progress bar, which should match the session variable where the value for updating this bar will be stored
    
    values - The values this progress bar can have, in the order they will be queried
    
    key - The key in the DataRecords that will be used for the session variable matching name
  - setDefaultRetryPolicy
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void setDefaultRetryPolicy(@Nullable
                                                                                                                                    RetryPolicy retryPolicy)
```
    Sets a retry policy that will affect all files in the scrape. This policy will be used by all scrapeable files that do not have a retry policy set for them. If a retry policy was manually set for them, this one will not be used.
    
    Parameters:
    
    retryPolicy - The retry policy to use by default, if no other retry policy is set.
  - getDefaultRetryPolicy
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
 @Nullable
public RetryPolicy getDefaultRetryPolicy()
```
    Gets the default retry policy to be used by each scrapeable file when one wasn't set for it.
    
    Returns:
    
    The default return policy, or null if there isn't one
  - executeScriptWithContext
```
@RequiredVersion(value=1)
public void executeScriptWithContext(java.lang.String scriptName)
                                                         throws java.lang.Exception
```
    Executes the named script, but preserves the current context (dataRecord, scrapeableFile, etc...)
    
    Parameters:
    
    scriptName - The name of the script to execute.
    
    Throws:
    
    java.lang.Exception - if the script couldn't be found
  - handleScriptError
```
@InternalOnly
public void handleScriptError(@NotNull
                                             ScriptException scriptException,
                                             ScriptContext scriptContext)
```
    Handles reporting and responding to a script error.
    
    Parameters:
    
    scriptException - The ScriptException that was thrown.
    
    scriptContext - The ScriptContext that produced the error.
  - saveStateToString
```
public java.lang.String saveStateToString(boolean saveCookies,
                                          boolean saveVariables)
```
    Saves the scrape state to an XML string
    
    Parameters:
    
    saveCookies - Should cookies be saved
    
    saveVariables - Should variables be saved
    
    Returns:
    
    The XML string containing the scrape state
  - saveStateToString
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public java.lang.String saveStateToString(boolean saveCookies,
                                                                                                                                            @Nullable
                                                                                                                                            java.util.Collection<java.lang.String> saveVariables)
```
    Saves the scrape state to an XML string
    
    Parameters:
    
    saveCookies - Should cookies be saved
    
    saveVariables - A Collection of variables to save, or null to save all of them
    
    Returns:
    
    The XML string containing the scrape state
  - loadStateFromString
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void loadStateFromString(@Nullable
                                                                                                                                  java.lang.String stateXML)
```
    Loads the scrape state from an xml string, but doesn't clear whatever was there. That should be done manually before calling this method.
    
    Parameters:
    
    stateXML - The xml containing the state to load
  - breakpoint
```
public void breakpoint(boolean logVariablesInNonWorkbench)
```
    Pauses the scrape and opens the breakpoint window. Also logs the message given, and optionally all the session variables
    
    Parameters:
    
    logVariablesInNonWorkbench - True if session variables should be written to the log when not running in workbench mode
    
    Throws:
    
    java.lang.Exception - In editions that are not allowed to call this method
  - breakpoint
```
public void breakpoint(@Nullable
                       java.lang.Object message)
```
    Pauses the scrape and opens the breakpoint window. Also logs the message given, and optionally all the session variables
    
    Parameters:
    
    message - A message to display
    
    Throws:
    
    java.lang.Exception - In editions that are not allowed to call this method
  - breakpoint
```
@RequiredVersion(value=1,
                 behavior=LOG_ERROR_AND_RETURN_NULL_NEG_ONE_OR_FALSE)
public void breakpoint(@Nullable
                                                                                                                         java.lang.Object message,
                                                                                                                         boolean logVariablesInNonWorkbench)
```
    Pauses the scrape and opens the breakpoint window. Also logs the message given, and optionally all the session variables
    
    Parameters:
    
    message - A message to display
    
    logVariablesInNonWorkbench - True if session variables should be written to the log when not running in workbench mode
  - getCurrentStack
```
@InternalOnly
 @NotNull
public java.lang.String[] getCurrentStack()
```
    Returns the current stack of scripts
    
    Returns:
    
    The current script stack
  - getAllVariables
```
@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getAllVariables()
```
    Returns a duplicate of the session variables. This is a shallow copy.
    
    Returns:
    
    A map that represents the session variables at the time this method was called
  - getAllInternalVariables
```
@NotNull
 @InternalOnly
public java.util.Map<java.lang.String,java.lang.Object> getAllInternalVariables()
```
    Returns a duplicate of the session internal variables. This is a shallow copy.
    
    Returns:
    
    A map that represents the session internal variables at the time this method was called
    
    Since:
    
    7.0.12a
  - getStopScrapingOnScriptError
```
@RequiredVersion(value=1)
public boolean getStopScrapingOnScriptError()
```
    Gets whether or not scraping should stop in the event of a script error.
    
    Returns:
    
    A boolean.
  - setStopScrapingOnScriptError
```
@RequiredVersion(value=1)
public void setStopScrapingOnScriptError(boolean stopScrapingOnScriptError)
```
    Sets whether or not scraping should stop in the event of a script error.
    
    Parameters:
    
    stopScrapingOnScriptError - A boolean.
  - getStopScrapingOnMaxRequestAttemptsReached
```
@RequiredVersion(value=1)
public boolean getStopScrapingOnMaxRequestAttemptsReached()
```
    Gets whether or not scraping should stop in the event of max request attempts reached.
    
    Returns:
    
    A boolean.
  - setStopScrapingOnMaxRequestAttemptsReached
```
@RequiredVersion(value=1)
public void setStopScrapingOnMaxRequestAttemptsReached(boolean stopScrapingOnMaxRequestAttemptsReached)
```
    Sets whether or not scraping should stop in the event of max request attempts reached.
    
    Parameters:
    
    stopScrapingOnMaxRequestAttemptsReached - A boolean.
  - getStopScrapingOnExtractorPatternTimeout
```
@RequiredVersion(value=1)
public boolean getStopScrapingOnExtractorPatternTimeout()
```
    Gets whether or not scraping should stop in the event of an extractor pattern timeout
    
    Returns:
    
    A boolean.
  - setStopScrapingOnExtractorPatternTimeout
```
@RequiredVersion(value=1)
public void setStopScrapingOnExtractorPatternTimeout(boolean stopScrapingOnExtractorPatternTimeout)
```
    Sets whether or not scraping should stop in the event of an extractor pattern timeout
    
    Parameters:
    
    stopScrapingOnExtractorPatternTimeout - A boolean.
  - getUseOnlySSLv3
```
public boolean getUseOnlySSLv3()
```
    Gets whether or not only SSLv3 should be used when connecting to remote servers.
    
    Returns:
    
    A boolean.
  - setUseOnlySSLv3
```
public void setUseOnlySSLv3(boolean useOnlySSLv3)
```
    Sets whether or not only SSLv3 should be used when connecting to remote servers.
    
    Parameters:
    
    useOnlySSLv3 - A boolean.
  - clearProxySettings
```
public void clearProxySettings()
```
  - addRandomDelayBetweenRequests
```
public void addRandomDelayBetweenRequests(long minMs,
                                          long maxMs)
```
    Adds a random delay between requests, ranging from the min to max number of milliseconds. Note that calling this method multiple times during a scrape will sum the pauses, so it should only be called once unless you intend to increase the delay between requests
    
    Parameters:
    
    minMs - The minimum number of milliseconds to wait
    
    maxMs - The maximum number of milliseconds to wait
  - getEventEngine
```
@NotNull
 @RequiredVersion(value=1)
public EventEngine getEventEngine()
```
    Returns the event engine used to add custom event callbacks
    
    Returns:
    
    The event engine used to add custom event callbacks
  - getEventEngineInternal
```
@NotNull
 @InternalOnly
public EventEngine getEventEngineInternal()
```
    Returns the event engine used to add custom event callbacks. This method is for internal use and ignores the edition check (basically to prevent exceptions when we don't really want them)
    
    Returns:
    
    The event engine used to add custom event callbacks
  - getIdentifier
```
@Nullable
 @InternalOnly
public java.lang.String getIdentifier()
```
  - setIdentifier
```
@InternalOnly
public void setIdentifier(java.lang.String identifier)
```
  - setAutoCloseAfterScrapeEnds
```
public void setAutoCloseAfterScrapeEnds(@NotNull
                                        java.io.Closeable closeable)
```
    Sets the given closeable to be automatically closed once the session completes. If an error occurs while calling the close method, an error will be logged
    
    Parameters:
    
    closeable - The closeable to close on completion of the session
    
    Since:
    
    7.0.2a

Class ScrapingSession

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

STRING_ACCORDING_TO_COOKIE_SPEC

STRING_ACCEPT

STRING_BEST_MATCH

STRING_COMPATIBILITY

STRING_NETSCAPE_DRAFT

STRING_REJECT

STRING_STRICT_MODE

INT_ACCEPT

INT_REJECT

INT_BEST_MATCH

INT_STRICT_MODE

STRING_APACHE_HTTPCLIENT

STRING_NING_ASYNC_HTTPCLIENT

STRING_ASYNC_HTTPCLIENT_2

STRING_CURL_HTTPCLIENT

INT_APACHE_HTTPCLIENT

INT_NING_ASYNC_HTTPCLIENT

INT_ASYNC_HTTPCLIENT_2

INT_CURL_HTTPCLIENT

STRING_HTTP_CLIENT_HTTPCLIENT

STRING_HTTP_CLIENT_MOZILLA

STRING_HTTP_CLIENT_IE

INT_HTTP_CLIENT_HTTPCLIENT

INT_HTTP_CLIENT_MOZILLA

INT_HTTP_CLIENT_IE

INFO_FLAVOR

flavors

Constructor Detail

ScrapingSession

ScrapingSession

ScrapingSession

ScrapingSession

Method Detail

unmarshalScrapingSession

prepareAnonymization

terminateAllAnonymousProxies

doLazyScrape

setDoLazyScrape

getHTTPClientType

setHTTPClientType

mapHTTPClientTypeStringToInt

mapHTTPClientIntToString

getMaxConcurrentFileDownloads

setMaxConcurrentFileDownloads

downloadFile

downloadFile

downloadFile

waitForFileDownloadsToComplete

setID

getID

getName

setName

getNameUpperCase

getFolder

setFolder

removeFromFolder

moveToNewFolder

getCookiePolicy

getCookiePolicyAsHttpClientString

setCookiePolicy

mapCookiePolicyHumanReadableStringToInt

mapCookiePolicyIntToHumanReadableString

setNode

getNode

getNextDefaultScrapeableFileName

getNumScrapeableFiles

getNumScrapeableFilesWithSequence

resetInitialValues

resetContainsNullableTokens

getCookies

getCookieList

getHttpClient