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, ClusterStateListener

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptService.ScriptType The type of a script, more specifically where it gets loaded from: - provided dynamically at request time - loaded from an index - loaded from file

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	close()
void	clusterChanged(ClusterChangedEvent event) Called when cluster state changes.
CompiledScript	compile(Script script, ScriptContext scriptContext, java.util.Map<java.lang.String,java.lang.String> params) Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.
void	deleteStoredScript(ClusterService clusterService, DeleteStoredScriptRequest request, ActionListener<DeleteStoredScriptResponse> listener)
ExecutableScript	executable(CompiledScript compiledScript, java.util.Map<java.lang.String,java.lang.Object> vars) Executes a previously compiled script provided as an argument
ExecutableScript	executable(Script script, ScriptContext scriptContext, java.util.Map<java.lang.String,java.lang.String> params) Compiles (or retrieves from cache) and executes the provided script
java.lang.String	getStoredScript(ClusterState state, GetStoredScriptRequest request)
SearchScript	search(SearchLookup lookup, Script script, ScriptContext scriptContext, java.util.Map<java.lang.String,java.lang.String> params) Compiles (or retrieves from cache) and executes the provided search script
ScriptStats	stats()
void	storeScript(ClusterService clusterService, PutStoredScriptRequest request, ActionListener<PutStoredScriptResponse> listener)

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,
                              java.util.Map<java.lang.String,java.lang.String> params)

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

storeScript

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

deleteStoredScript

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

getStoredScript

public java.lang.String getStoredScript(ClusterState state,
                                        GetStoredScriptRequest request)

executable

public ExecutableScript executable(Script script,
                                   ScriptContext scriptContext,
                                   java.util.Map<java.lang.String,java.lang.String> params)

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

executable

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

Executes a previously compiled script provided as an argument

search

public SearchScript search(SearchLookup lookup,
                           Script script,
                           ScriptContext scriptContext,
                           java.util.Map<java.lang.String,java.lang.String> params)

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

stats

public ScriptStats stats()

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Specified by:

clusterChanged in interface ClusterStateListener