Package org.frankframework.javascript

Class GraalJS

java.lang.Object

org.frankframework.javascript.GraalJS

All Implemented Interfaces:

JavascriptEngine<ScriptEngine>

public class GraalJS
extends Object
implements JavascriptEngine<ScriptEngine>

Javascript engine implementation of GraalJS. If high performance execution of JavaScript code is required, enable the following JVM options: "-XX:+UnlockExperimentalVMOptions -XX:+EnableJVMCI" or use the GraalVM Java distribution. Otherwise, the Javascript code is interpreted on every execution.

GraalJS is in Beta phase, so it is not supported by Frank!Framework yet.

Since:

8.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GraalJS.JavaCallback

Constructor Summary

Constructors

Constructor	Description
GraalJS()

Method Summary

Modifier and Type	Method	Description
void	closeRuntime()	Closes the runtime for the specified engine
Object	executeFunction(String name, Object... parameters)	Executes a javascript function and returns the result of that function
void	executeScript(String script)	Read the functions of a given javascript file
ScriptEngine	getEngine()	Getter for the runtime of the specified engine
void	registerCallback(ISender sender, PipeLineSession session)	Allows for senders to be called by the Javascript function.
void	setGlobalAlias(String alias)
void	setResultHandler(ResultHandler resultHandler)	Registers the result and error functions to be handled by the given result handler.
void	startRuntime()	Initialize the runtime for the specified engine

Methods inherited from class java.lang.Object

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

Constructor Details

GraalJS

public GraalJS()

Method Details

setGlobalAlias

public void setGlobalAlias(String alias)

Specified by:

setGlobalAlias in interface JavascriptEngine<ScriptEngine>

Parameters:

alias - An identifier which describes the script(s) that are being executed.

startRuntime

public void startRuntime()
                  throws JavascriptException

Description copied from interface: JavascriptEngine

Initialize the runtime for the specified engine

Specified by:

startRuntime in interface JavascriptEngine<ScriptEngine>

Throws:

JavascriptException

executeScript

public void executeScript(String script)
                   throws JavascriptException

Description copied from interface: JavascriptEngine

Read the functions of a given javascript file

Specified by:

executeScript in interface JavascriptEngine<ScriptEngine>

Parameters:

script - String containing the contents of the javascript file in which the function(s) to be executed are specified.

Throws:

JavascriptException

executeFunction

public Object executeFunction(String name,
 Object... parameters)
                       throws JavascriptException

Description copied from interface: JavascriptEngine

Executes a javascript function and returns the result of that function

Specified by:

executeFunction in interface JavascriptEngine<ScriptEngine>

Parameters:

name - The name of the javascript function as given in the javascript file.

parameters - An array containing the parameters for the javascript function, given in the adapter configuration

Returns:

The result of the javascript function is returned.

Throws:

JavascriptException

closeRuntime

public void closeRuntime()

Description copied from interface: JavascriptEngine

Closes the runtime for the specified engine

Specified by:

closeRuntime in interface JavascriptEngine<ScriptEngine>

getEngine

public ScriptEngine getEngine()

Description copied from interface: JavascriptEngine

Getter for the runtime of the specified engine

Specified by:

getEngine in interface JavascriptEngine<ScriptEngine>

Returns:

Returns the runtime instance

registerCallback

public void registerCallback(ISender sender,
 PipeLineSession session)

Description copied from interface: JavascriptEngine

Allows for senders to be called by the Javascript function. Sender needs to be given in the adapter configuration, a Javascript function can call the sender, using the name of the sender as a function call.

Specified by:

registerCallback in interface JavascriptEngine<ScriptEngine>

Parameters:

sender - The sender given in the adapter configuration

setResultHandler

public void setResultHandler(ResultHandler resultHandler)

Description copied from interface: JavascriptEngine

Registers the result and error functions to be handled by the given result handler.

Specified by:

setResultHandler in interface JavascriptEngine<ScriptEngine>

Parameters:

resultHandler - Object to handle results and errors.