com.screenscraper.util.javascript

Class DomSimulator

java.lang.Object

com.screenscraper.util.javascript.DomSimulator

public class DomSimulator
extends java.lang.Object

Class for getting a simulated browser object.

Version:

7.0.3a

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_STORAGE_SESSION_VARIABLE The name of the session variable used to store local session storage for the ScriptEngine
static java.lang.String	SESSION_STORAGE_SESSION_VARIABLE The name of the session variable used to store session storage for the ScriptEngine

Method Summary

Modifier and Type	Method and Description
static java.lang.Runnable	convertFunctionToRunnable(java.lang.Runnable runnable) Simple method for use in javascript to convert a function call to a runnable (for methods that take Callable or Runnable)
static ComplexJavaScriptEngine	getComplexJavaScriptEngine(ScrapingSession session, ScrapeableFile scrapeableFile, IssuedRequestHandler issuedRequestHandler, java.lang.String pageContent) Gets a script engine setup to run javascript more like a browser.
static javax.script.ScriptEngine	getSimpleJavaScriptEngine(ScrapingSession session, ScrapeableFile scrapeableFile) Gets a script engine setup to run javascript for the scrapeable file (note this won't modify the last response tab data).
static javax.script.ScriptEngine	getSimpleJavaScriptEngine(ScrapingSession session, java.lang.String url, java.lang.String referrer, java.lang.String encoding, java.lang.String userAgent, java.lang.String pageContent) Gets a script engine setup to run javascript for the given input data.
static java.util.Map<java.lang.String,java.lang.String>	parseUserAgentString(java.lang.String inputString) Parses a user agent string into parts a browser would indicate

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_STORAGE_SESSION_VARIABLE

public static final java.lang.String LOCAL_STORAGE_SESSION_VARIABLE

The name of the session variable used to store local session storage for the ScriptEngine

See Also:

Constant Field Values

SESSION_STORAGE_SESSION_VARIABLE

public static final java.lang.String SESSION_STORAGE_SESSION_VARIABLE

The name of the session variable used to store session storage for the ScriptEngine

See Also:

Constant Field Values

Method Detail

convertFunctionToRunnable

@InternalOnly
public static java.lang.Runnable convertFunctionToRunnable(java.lang.Runnable runnable)

Simple method for use in javascript to convert a function call to a runnable (for methods that take Callable or Runnable)

Parameters:

runnable - The input function

Returns:

The runnable

parseUserAgentString

@NotNull
 @InternalOnly
public static java.util.Map<java.lang.String,java.lang.String> parseUserAgentString(@NotNull
                                                                                                              java.lang.String inputString)

Parses a user agent string into parts a browser would indicate

Parameters:

inputString - The input string

Returns:

The mapping of parts to browser names

getComplexJavaScriptEngine

@NotNull
 @RequiredVersion(value=2)
public static ComplexJavaScriptEngine getComplexJavaScriptEngine(@NotNull
                                                                                                       ScrapingSession session,
                                                                                                       @Nullable
                                                                                                       ScrapeableFile scrapeableFile,
                                                                                                       @Nullable
                                                                                                       IssuedRequestHandler issuedRequestHandler,
                                                                                                       @NotNull
                                                                                                       java.lang.String pageContent)
                                                                                                throws javax.script.ScriptException

Gets a script engine setup to run javascript more like a browser. This should be manually closed once you are done with it. The method close method for the script engine is: engine.eval("ScrapeEnv.close()");. If you don't close it it will leak the scheduling thread it uses (but only if the setTimeout or setInterval methods were called in the javascript). As of version 7.0.6a this will call the close method at the end of the scraping session. You should still close it prior to that to release resources, but it should clean itself if you didn't

Parameters:

session - The current scraping session

scrapeableFile - The current scrapeable file (used for some extra details for the current page, but not required)

issuedRequestHandler - A handler for the requests issued to load pages and scripts, or null to use a default one

pageContent - The content of the page (not including headers) to use for the DOM

Returns:

A engine with a document and other browser objects defined which will function more like a browser

Throws:

javax.script.ScriptException - If there is an error executing the setup code

getSimpleJavaScriptEngine

@RequiredVersion(value=2)
public static javax.script.ScriptEngine getSimpleJavaScriptEngine(@NotNull
                                                                                             ScrapingSession session,
                                                                                             @NotNull
                                                                                             ScrapeableFile scrapeableFile)
                                                                                      throws java.net.URISyntaxException,
                                                                                             javax.script.ScriptException

Gets a script engine setup to run javascript for the scrapeable file (note this won't modify the last response tab data). Also, the defined browser objects are missing some functionality, but some basic things are there to help with javascript blocks. Some methods and properties may not be defined, and those that are may not be perfect (but will be useful for many javascript blocks).

Parameters:

session - The current scraping session

scrapeableFile - The scrapeable file for which to build the objects

Returns:

A engine with a document and other browser objects defined for the given scrapeable file

Throws:

java.net.URISyntaxException - If the url for the scrapeable file is invalid

javax.script.ScriptException - If there is an error executing the setup code

getSimpleJavaScriptEngine

@RequiredVersion(value=2)
public static javax.script.ScriptEngine getSimpleJavaScriptEngine(@NotNull
                                                                                             ScrapingSession session,
                                                                                             @NotNull
                                                                                             java.lang.String url,
                                                                                             @Nullable
                                                                                             java.lang.String referrer,
                                                                                             @NotNull
                                                                                             java.lang.String encoding,
                                                                                             @NotNull
                                                                                             java.lang.String userAgent,
                                                                                             @NotNull
                                                                                             java.lang.String pageContent)
                                                                                      throws java.net.URISyntaxException,
                                                                                             javax.script.ScriptException

Gets a script engine setup to run javascript for the given input data. Also, the defined browser objects are missing some functionality, but some basic things are there to help with javascript blocks. Some methods and properties may not be defined, and those that are may not be perfect (but will be useful for many javascript blocks)

Parameters:

session - The current session (used for logging or other session related stuff)

url - The url for the current page

referrer - The referring url

encoding - The encoding used when parsing

userAgent - The user agent string used to request the content

pageContent - The content of the page for which we are building the data

Returns:

A engine with a document and other browser objects defined for the input data

Throws:

java.net.URISyntaxException - If the url is invalid

javax.script.ScriptException - If there is an error executing the setup code