org.elasticsearch.script

Class ScriptService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.script.ScriptService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ClusterStateApplier

public class ScriptService
extends AbstractComponent
implements java.io.Closeable, ClusterStateApplier

Field Summary

Fields

Modifier and Type	Field and Description
static Setting<java.lang.Boolean>	SCRIPT_AUTO_RELOAD_ENABLED_SETTING
static Setting<TimeValue>	SCRIPT_CACHE_EXPIRE_SETTING
static Setting<java.lang.Integer>	SCRIPT_CACHE_SIZE_SETTING
static Setting<java.lang.Integer>	SCRIPT_MAX_COMPILATIONS_PER_MINUTE
static Setting<java.lang.Integer>	SCRIPT_MAX_SIZE_IN_BYTES

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
ScriptService(Settings settings, Environment env, ResourceWatcherService resourceWatcherService, ScriptEngineRegistry scriptEngineRegistry, ScriptContextRegistry scriptContextRegistry, ScriptSettings scriptSettings)

Method Summary

Modifier and Type	Method and Description
void	applyClusterState(ClusterChangedEvent event) Called when a new cluster state (ClusterChangedEvent.state() needs to be applied
void	close()
CompiledScript	compile(Script script, ScriptContext scriptContext) Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.
CompiledTemplate	compileTemplate(Script script, ScriptContext scriptContext) Compiles a template.
void	deleteStoredScript(ClusterService clusterService, DeleteStoredScriptRequest request, ActionListener<DeleteStoredScriptResponse> listener)
ExecutableScript	executable(CompiledScript compiledScript, java.util.Map<java.lang.String,java.lang.Object> params) Executes a previously compiled script provided as an argument
StoredScriptSource	getStoredScript(ClusterState state, GetStoredScriptRequest request)
boolean	isLangSupported(java.lang.String lang)
void	putStoredScript(ClusterService clusterService, PutStoredScriptRequest request, ActionListener<PutStoredScriptResponse> listener)
SearchScript	search(SearchLookup lookup, CompiledScript compiledScript, java.util.Map<java.lang.String,java.lang.Object> params) Binds provided parameters to a compiled script returning a SearchScript ready for execution
SearchScript	search(SearchLookup lookup, Script script, ScriptContext scriptContext) Compiles (or retrieves from cache) and executes the provided search script
ScriptStats	stats()

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

SCRIPT_CACHE_SIZE_SETTING

public static final Setting<java.lang.Integer> SCRIPT_CACHE_SIZE_SETTING

SCRIPT_CACHE_EXPIRE_SETTING

public static final Setting<TimeValue> SCRIPT_CACHE_EXPIRE_SETTING

SCRIPT_AUTO_RELOAD_ENABLED_SETTING

public static final Setting<java.lang.Boolean> SCRIPT_AUTO_RELOAD_ENABLED_SETTING

SCRIPT_MAX_SIZE_IN_BYTES

public static final Setting<java.lang.Integer> SCRIPT_MAX_SIZE_IN_BYTES

SCRIPT_MAX_COMPILATIONS_PER_MINUTE

public static final Setting<java.lang.Integer> SCRIPT_MAX_COMPILATIONS_PER_MINUTE

Constructor Detail

ScriptService

public ScriptService(Settings settings,
                     Environment env,
                     ResourceWatcherService resourceWatcherService,
                     ScriptEngineRegistry scriptEngineRegistry,
                     ScriptContextRegistry scriptContextRegistry,
                     ScriptSettings scriptSettings)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

compile

public CompiledScript compile(Script script,
                              ScriptContext scriptContext)

Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.

compileTemplate

public CompiledTemplate compileTemplate(Script script,
                                        ScriptContext scriptContext)

Compiles a template. Note this will be moved to a separate TemplateService in the future.

isLangSupported

public boolean isLangSupported(java.lang.String lang)

putStoredScript

public void putStoredScript(ClusterService clusterService,
                            PutStoredScriptRequest request,
                            ActionListener<PutStoredScriptResponse> listener)

deleteStoredScript

public void deleteStoredScript(ClusterService clusterService,
                               DeleteStoredScriptRequest request,
                               ActionListener<DeleteStoredScriptResponse> listener)

getStoredScript

public StoredScriptSource getStoredScript(ClusterState state,
                                          GetStoredScriptRequest request)

executable

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

Executes a previously compiled script provided as an argument

search

public SearchScript search(SearchLookup lookup,
                           Script script,
                           ScriptContext scriptContext)

Compiles (or retrieves from cache) and executes the provided search script

search

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

Binds provided parameters to a compiled script returning a SearchScript ready for execution

stats

public ScriptStats stats()

applyClusterState

public void applyClusterState(ClusterChangedEvent event)

Description copied from interface: ClusterStateApplier

Called when a new cluster state (ClusterChangedEvent.state() needs to be applied

Specified by:

applyClusterState in interface ClusterStateApplier