org.elasticsearch.script

Class NativeScriptEngineService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.script.NativeScriptEngineService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ScriptEngineService

public class NativeScriptEngineService
extends AbstractComponent
implements ScriptEngineService

A native script engine service.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
NativeScriptEngineService(Settings settings, java.util.Map<java.lang.String,NativeScriptFactory> scripts)

Method Summary

Modifier and Type	Method and Description
void	close()
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()
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 class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

NativeScriptEngineService

public NativeScriptEngineService(Settings settings,
                                 java.util.Map<java.lang.String,NativeScriptFactory> scripts)

Method Detail

getType

public java.lang.String getType()

Specified by:

getType in interface ScriptEngineService

getExtension

public java.lang.String getExtension()

Specified by:

getExtension in interface ScriptEngineService

compile

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

Description copied from interface: ScriptEngineService

Compiles a script.

Specified by:

compile in interface ScriptEngineService

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

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

Specified by:

executable in interface ScriptEngineService

search

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

Specified by:

search in interface ScriptEngineService

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isInlineScriptEnabled

public boolean isInlineScriptEnabled()

Description copied from interface: ScriptEngineService

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

Specified by:

isInlineScriptEnabled in interface ScriptEngineService