org.markysoft.vani.core.javascript

Class JavaScriptLoader

java.lang.Object

org.markysoft.vani.core.javascript.JavaScriptLoader

public class JavaScriptLoader
extends Object

This class is responsible for reading source code of declared js-interfaces.

The resource path can be a filesystem path or classpath. Both are supported and could be mixed.

For details of the source declaration see JavaScript.

Author:

Thomas

See Also:

JavaScript, DetectionScript, JsCallFunction, JavaScriptSource

Constructor Summary

Constructors

Constructor and Description
JavaScriptLoader()

Method Summary

Modifier and Type	Method and Description
protected StringBuilder	fromClasspath(String classpath, VaniContext vaniContext) method to read javsScript file specified by path from classpath.
protected StringBuilder	fromFilesystem(String sourcePath, VaniContext vaniContext) method to read javsScript file specified by path from file system.
protected Set<String>	getResourcesPathFromClasspath(String classpath, VaniContext context) method to get paths of classpath resources.
protected List<Path>	getResourcesPathFromFilesystem(String resourcePath) method to get paths of resources on filesystem.
<T> JavaScriptSource<T>	load(JavaScript javaScript, Class<T> jsInterface, VaniContext vaniContext) This method is responsible for loading the javascript code from filesystem or classpath.
protected <T> void	setCallFunction(JavaScriptSource<T> jsSource, VaniContext vaniContext) This method will look for method annotated with JsCallFunction in the target interface of provided JavaScriptSource.
protected <T> void	setDetectedMethod(JavaScriptSource<T> jsSource) This method will look for method annotated with (DetectionScript in taret interface of provided JavaScriptSource.
void	setReflectionUtil(VaniReflectionUtil reflectionUtil)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaScriptLoader

public JavaScriptLoader()

Method Detail

load

public <T> JavaScriptSource<T> load(JavaScript javaScript,
                                    Class<T> jsInterface,
                                    VaniContext vaniContext)
                             throws JavaScriptReadException

This method is responsible for loading the javascript code from filesystem or classpath. Additionally, the detection script and custom call function will be resolved when declared.

Parameters:

javaScript - annotation with source declaration

jsInterface -

vaniContext -

Returns:

returns a JavaScriptSource object, which contains the source code, custom call function and detection script. If resource could not be found, object will have an empty source.

Throws:

JavaScriptReadException - will be thrown if an IOException occurs during reading js source

setDetectedMethod

protected <T> void setDetectedMethod(JavaScriptSource<T> jsSource)

This method will look for method annotated with (DetectionScript in taret interface of provided JavaScriptSource. If a method is found, the javascript code of the annotation will be set to specified jsSource as detection script.

Parameters:

jsSource -

setCallFunction

protected <T> void setCallFunction(JavaScriptSource<T> jsSource,
                                   VaniContext vaniContext)

This method will look for method annotated with JsCallFunction in the target interface of provided JavaScriptSource. If a method is found, the corresponding source will be loaded and set to the provided JavaScriptSource as custom javascript call function.

It supports filesystem and classpath declaration.

Parameters:

jsSource -

vaniContext -

fromClasspath

protected StringBuilder fromClasspath(String classpath,
                                      VaniContext vaniContext)
                               throws JavaScriptReadException

method to read javsScript file specified by path from classpath. If classpath contains a wildcard or there are resources with same name but paths are different, multiple entries will be returned.

If you provide resource and path, only matching resources with provided path will be used.

Parameters:

sourcePath -

vaniContext -

Returns:

returns StringBuffer containing only source code of specified js-script by sourcePath or empty StringBuilder if file does not exist

Throws:

JavaScriptReadException - will be thrown if an IOException occurs during reading js source

fromFilesystem

protected StringBuilder fromFilesystem(String sourcePath,
                                       VaniContext vaniContext)
                                throws JavaScriptReadException

method to read javsScript file specified by path from file system.

Parameters:

sourcePath -

vaniContext -

Returns:

returns StringBuffer containing only source code of specified js-script by sourcePath or empty StringBuilder if file does not exist

Throws:

JavaScriptReadException - will be thrown if an error occurs during collecting paths to specified resources or reading source file

getResourcesPathFromFilesystem

protected List<Path> getResourcesPathFromFilesystem(String resourcePath)
                                             throws Throwable

method to get paths of resources on filesystem. Regex is NOT supported.

If you don't provide an path, it will look in current working path for it.

Parameters:

sourceData -

Returns:

returns paths for all matching filesystem resources

Throws:

Throwable - will be thrown if an error occurs during search for given resources on filesystem

getResourcesPathFromClasspath

protected Set<String> getResourcesPathFromClasspath(String classpath,
                                                    VaniContext context)

method to get paths of classpath resources. If classpath contains a wildcard or there are resources with same name but paths are different, multiple entries will be returned.

If you provide resource and path, only matching resources with provided path will be returned.

Parameters:

classpath - name of resource (also path and regex are supported)

context -

Returns:

returns paths for all matching classpath resources

setReflectionUtil

public void setReflectionUtil(VaniReflectionUtil reflectionUtil)