org.markysoft.vani.core.util

Class JavaScriptMethodInterceptor

java.lang.Object

org.markysoft.vani.core.util.JavaScriptMethodInterceptor

public class JavaScriptMethodInterceptor
extends Object

This class is responsible for executing the js function of call corresponding method of js interface. It also prepare the argument list and call manual implementation of methods.

Author:

Thomas

See Also:

JavaScript, JavaScriptFunction, ManualJavaScriptInterface

Constructor Summary

Constructors

Constructor and Description
JavaScriptMethodInterceptor(JavaScriptSource<?> jsSource, VaniContext vaniContext, List<Object> manualJSInterfaceImplemenations)

Method Summary

Modifier and Type	Method and Description
protected Object[]	filterArguments(Method jsMethod, Object[] arguments, Map<Class<?>,Object> filteredEntries, Class<?>... filters) This method will extract all parameters, its class is assignable from provided filtering classes.
protected VaniJavaScriptExecutor	getExecutor(org.openqa.selenium.JavascriptExecutor jsExecutor)
protected <T> T	handleResult(Object result, Class<T> returnType, org.openqa.selenium.WebDriver webDriver) This method checks whether there is a type handler for corresponding return type and call it when exists.
Object	intercept(Object[] arguments, Method invokedMethod, Class<?> targetClass)
protected Object	invokeManualImplementation(Method method, Object... arguments) This method calls the specified method with given arguments on corresponding manual implementation instance.
protected Object[]	prepareArgumentsForCustomCallFunc(Object[] arguments, Map<Class<?>,Object> filteredArguments, String jsMethodName, JavaScriptFunction jsFunctionAnnotation) This method prepares the arguments array for using custom call function.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaScriptMethodInterceptor

public JavaScriptMethodInterceptor(JavaScriptSource<?> jsSource,
                                   VaniContext vaniContext,
                                   List<Object> manualJSInterfaceImplemenations)

Method Detail

intercept

@RuntimeType
public Object intercept(@AllArguments
                                      Object[] arguments,
                                      @Origin
                                      Method invokedMethod,
                                      @Origin
                                      Class<?> targetClass)

handleResult

protected <T> T handleResult(Object result,
                             Class<T> returnType,
                             org.openqa.selenium.WebDriver webDriver)

This method checks whether there is a type handler for corresponding return type and call it when exists.

Parameters:

result -

returnType -

webDriver -

Returns:

returns provided result or converted value by registered TypeHandler.

getExecutor

protected VaniJavaScriptExecutor getExecutor(org.openqa.selenium.JavascriptExecutor jsExecutor)

filterArguments

protected Object[] filterArguments(Method jsMethod,
                                   Object[] arguments,
                                   Map<Class<?>,Object> filteredEntries,
                                   Class<?>... filters)

This method will extract all parameters, its class is assignable from provided filtering classes. So it reduces the provided array and add filtered entries to specified filteredEntries map. The key of the map will be the filtered class and not the class of parameter value.

If a parameter entry is NULL, it will extracts the desired type from corresponding js-method.

Parameters:

jsMethod - calling js-method

arguments - arguments for calling js-method

filteredEntries - map containing all filtered matches

filters - array with filter classes

Returns:

returns the provided array without values filtered by specified filters or NULL if no filters or arguments are available.

prepareArgumentsForCustomCallFunc

protected Object[] prepareArgumentsForCustomCallFunc(Object[] arguments,
                                                     Map<Class<?>,Object> filteredArguments,
                                                     String jsMethodName,
                                                     JavaScriptFunction jsFunctionAnnotation)

This method prepares the arguments array for using custom call function. If current JavaScriptSource has no call function, provided arguments array will be returned.

But if there is one, the returned array will only contain the required parameters for it. So this method is responsible for handling JsFunctionArguments, JsFunctionName, GlobalReference.

All others parameters will be ignored

Parameters:

arguments - arguments of calling js function

filteredArguments -

jsMethodName - name of called method of js interface

jsFunctionAnnotation - annotation of called method of js-interface

Returns:

invokeManualImplementation

protected Object invokeManualImplementation(Method method,
                                            Object... arguments)
                                     throws JavaScriptException

This method calls the specified method with given arguments on corresponding manual implementation instance.

Parameters:

method -

arguments -

Returns:

returns result of corresponding method of manual implementation or NULL if method has void as return type.

Throws:

JavaScriptException