org.elasticsearch.script

Interface ScriptEngineService

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

NativeScriptEngineService

public interface ScriptEngineService
extends java.io.Closeable

Method Summary

Modifier and Type	Method and Description
java.lang.Object	compile(java.lang.String scriptName, java.lang.String scriptSource, java.util.Map<java.lang.String,java.lang.String> params) Compiles a script.
ExecutableScript	executable(CompiledScript compiledScript, java.util.Map<java.lang.String,java.lang.Object> vars)
java.lang.String	getExtension()
java.lang.String	getType()
default boolean	isInlineScriptEnabled() Returns true if this scripting engine can safely accept inline scripts by default.
SearchScript	search(CompiledScript compiledScript, SearchLookup lookup, java.util.Map<java.lang.String,java.lang.Object> vars)

Methods inherited from interface java.io.Closeable

close

Method Detail

getType

java.lang.String getType()

getExtension

java.lang.String getExtension()

compile

java.lang.Object compile(java.lang.String scriptName,
                         java.lang.String scriptSource,
                         java.util.Map<java.lang.String,java.lang.String> params)

Compiles a script.

Parameters:

scriptName - name of the script. null if it is anonymous (inline). For a file script, its the file name (with extension). For a stored script, its the identifier.

scriptSource - actual source of the script

params - compile-time parameters (such as flags to the compiler)

executable

ExecutableScript executable(CompiledScript compiledScript,
                            @Nullable
                            java.util.Map<java.lang.String,java.lang.Object> vars)

search

SearchScript search(CompiledScript compiledScript,
                    SearchLookup lookup,
                    @Nullable
                    java.util.Map<java.lang.String,java.lang.Object> vars)

isInlineScriptEnabled

default boolean isInlineScriptEnabled()

Returns true if this scripting engine can safely accept inline scripts by default. The default is false