org.markysoft.vani.core.javascript

Class VaniJavaScriptExecutor

java.lang.Object

org.markysoft.vani.core.javascript.VaniJavaScriptExecutor

All Implemented Interfaces:

org.openqa.selenium.JavascriptExecutor

public class VaniJavaScriptExecutor
extends Object
implements org.openqa.selenium.JavascriptExecutor

This class is a wrapper for the using JavascriptExecutor. It prepares the source, which is sent to the browser. This means that all dependencies, js-interface's sources and plugins are concatenated if it's necessary.

Author:

Thomas

See Also:

JavaScriptCallFunction, JsCallFunction, JavaScript, JavaScriptFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BOUND_CALL
protected static String	CALL
protected org.openqa.selenium.JavascriptExecutor	jsExecutor
protected JavaScriptSource<?>	jsSource
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
VaniJavaScriptExecutor(org.openqa.selenium.JavascriptExecutor jsExecutor, JavaScriptSource<?> jsSource)

Method Summary

Modifier and Type	Method and Description
protected void	appendSource(StringBuilder builder, JavaScriptSource<?> jsSource, Set<JavaScriptSource<?>> processingSources) This method resolves the source code for specified JavaScriptSource and set it to provided StringBuilder.The builder will contains following things at the end in this order: dependencies, which are not already available (see DetectionScript) or already appended to the builder.
protected Object	doExecute(String script, Object... args) This method is only wrapper for JavascriptExecutor.executeScript(String, Object...) and check whether there was a js-error.
protected Object	doExecuteAsync(String script, Object... args) This method is only wrapper for JavascriptExecutor.executeAsyncScript(String, Object...) and check whether there was a js-error.
Object	execute(String methodName, JavaScriptFunction jsFunctionAnnotation, Object... args) Executes JavaScript in the context of the currently selected frame or window.
Object	executeAsyncScript(String script, Object... args)
Object	executeScript(String script, Object... args)
protected String	getCallSource(String funcName) This method builds the call source.
org.openqa.selenium.JavascriptExecutor	getWrappedExecutor()
protected Object	handleResult(Object result) This method checks whether the javascript execution returned an string starting with js-error key.
protected boolean	mustInject(JavaScriptSource<?> jsSource) This method checks whether provided JavaScriptSource declares a detection script.
protected String	prepareSource(String source) This method will prepare source code, which will be sent to browser.

Methods inherited from class java.lang.Object

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

Field Detail

BOUND_CALL

protected static final String BOUND_CALL

See Also:

Constant Field Values

CALL

protected static final String CALL

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

jsExecutor

protected org.openqa.selenium.JavascriptExecutor jsExecutor

jsSource

protected JavaScriptSource<?> jsSource

Constructor Detail

VaniJavaScriptExecutor

public VaniJavaScriptExecutor(org.openqa.selenium.JavascriptExecutor jsExecutor,
                              JavaScriptSource<?> jsSource)

Method Detail

executeScript

public Object executeScript(String script,
                            Object... args)

Specified by:

executeScript in interface org.openqa.selenium.JavascriptExecutor

executeAsyncScript

public Object executeAsyncScript(String script,
                                 Object... args)

Specified by:

executeAsyncScript in interface org.openqa.selenium.JavascriptExecutor

execute

public Object execute(String methodName,
                      JavaScriptFunction jsFunctionAnnotation,
                      Object... args)

Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

Within the script, use document to refer to the current document. Note that local variables will not be available once the script has finished executing, though global variables will persist.

If the script has a return value (i.e. if the script contains a return statement), then the following steps will be taken:

• For an HTML element, this method returns a WebElement
• For a decimal, a Double is returned
• For a non-decimal number, a Long is returned
• For a boolean, a Boolean is returned
• For all other cases, a String is returned.
• For an array, return a List<Object> with each object following the rules above. We support nested lists.
• Unless the value is null or there is no return value, in which null is returned

Arguments must be a number, a boolean, a String, WebElement, or a List of any combination of the above. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" magic variable, as if the function were called via "Function.apply"

Parameters:

methodName - name of calling js-inteface method

jsFunctionAnnotation - annotation of calling js-interface method

args - The arguments to the script. May be empty

Returns:

One of Boolean, Long, String, List or WebElement or custom type. Or null.

See Also:

VaniJavaScriptExecutor#CALL} for wrapping call source

getCallSource

protected String getCallSource(String funcName)

This method builds the call source. This will be used to call a function of the associated source of js-interface. If the js-interface declares no custom call function (see JsCallFunction), the function will be called by apply-function.

Parameters:

funcName - name of javascript function

Returns:

returns the default call function if no custom one is declared, else custom one will be returned.

See Also:

VaniJavaScriptExecutor#BOUND_CALL} (default call source)

doExecute

protected Object doExecute(String script,
                           Object... args)

This method is only wrapper for JavascriptExecutor.executeScript(String, Object...) and check whether there was a js-error.

Parameters:

script - script code which should be executed

args - The arguments to the script. May be empty.

Returns:

returns the result of executed javascript.

Throws:

JavaScriptException - will be thrown, when provided argument is a string starting with js-error key

doExecuteAsync

protected Object doExecuteAsync(String script,
                                Object... args)
                         throws JavaScriptException

This method is only wrapper for JavascriptExecutor.executeAsyncScript(String, Object...) and check whether there was a js-error.

Parameters:

script - script code which should be executed

args - The arguments to the script. May be empty.

Returns:

returns the result of executed javascript.

Throws:

JavaScriptException - will be thrown, when provided argument is a string starting with js-error key

handleResult

protected Object handleResult(Object result)
                       throws JavaScriptException

This method checks whether the javascript execution returned an string starting with js-error key. This key tell vani, that an error is occurred during script execution. If this is true, a JavaScriptException will be thrown, which contains the returns script error.

Parameters:

result - result of the javascript execution

Returns:

returns the provided argument, only if it is not a string starting with js-error key.

Throws:

JavaScriptException - will be thrown, when provided argument is a string starting with js-error key

prepareSource

protected String prepareSource(String source)
                        throws JavaScriptException

This method will prepare source code, which will be sent to browser. The result also includes the code of the corresponding js-interface inclusive all dependencies and plugins, but only if it's necessary.

Parameters:

source - source of bound function

Returns:

returns the source code, which will be sent to browser.

Throws:

JavaScriptException - will be thrown if an error occurred during checking whether script must be injected.

See Also:

VaniJavaScriptExecutor#appendSource(StringBuilder, JavaScriptSource, Set)}

appendSource

protected void appendSource(StringBuilder builder,
                            JavaScriptSource<?> jsSource,
                            Set<JavaScriptSource<?>> processingSources)
                     throws JavaScriptException

This method resolves the source code for specified JavaScriptSource and set it to provided StringBuilder.The builder will contains following things at the end in this order:

• dependencies, which are not already available (see DetectionScript) or already appended to the builder. If a dependency also declares a dependency or plugin it will be handled in same order.
• source of js-interface If source is already available (see DetectionScript), it will be skipped.
• plugin, which are not already appended to the builder.

Parameters:

builder -

jsSource -

processingSources -

Throws:

JavaScriptException - will be thrown, when an error occurred during checking whether script is already available.

mustInject

protected boolean mustInject(JavaScriptSource<?> jsSource)

This method checks whether provided JavaScriptSource declares a detection script. If there is a detection script, it will be executed and its return value will be inverted and returned.

Parameters:

jsSource -

Returns:

returns true, if no detection script is available or the declared detection script returns false, else false will be returned

getWrappedExecutor

public org.openqa.selenium.JavascriptExecutor getWrappedExecutor()