org.elasticsearch.script

Class ScriptService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.script.ScriptService

All Implemented Interfaces:

Closeable, AutoCloseable

public class ScriptService
extends AbstractComponent
implements Closeable

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 String	DEFAULT_LANG
static String	DEFAULT_SCRIPTING_LANGUAGE_SETTING
static String	SCRIPT_AUTO_RELOAD_ENABLED_SETTING
static String	SCRIPT_CACHE_EXPIRE_SETTING
static int	SCRIPT_CACHE_SIZE_DEFAULT
static String	SCRIPT_CACHE_SIZE_SETTING
static ParseField	SCRIPT_FILE Deprecated. Use ScriptService.ScriptType.getParseField() instead. This should be removed in 2.0
static ParseField	SCRIPT_ID Deprecated. Use ScriptService.ScriptType.getParseField() instead. This should be removed in 2.0
static String	SCRIPT_INDEX
static ParseField	SCRIPT_INLINE Deprecated. Use ScriptService.ScriptType.getParseField() instead. This should be removed in 2.0
static ParseField	SCRIPT_LANG Deprecated. Use Script.ScriptField instead. This should be removed in 2.0

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
ScriptService(Settings settings, Environment env, Set<ScriptEngineService> scriptEngines, ResourceWatcherService resourceWatcherService, ScriptContextRegistry scriptContextRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
CompiledScript	compile(Script script, ScriptContext scriptContext, HasContextAndHeaders headersContext, Map<String,String> params) Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.
CompiledScript	compileInternal(Script script, HasContextAndHeaders context, Map<String,String> params) Compiles a script straight-away, or returns the previously compiled and cached script, without checking if it can be executed based on settings.
void	deleteScriptFromIndex(DeleteIndexedScriptRequest request, ActionListener<DeleteResponse> listener)
ExecutableScript	executable(CompiledScript compiledScript, Map<String,Object> vars) Executes a previously compiled script provided as an argument
ExecutableScript	executable(Script script, ScriptContext scriptContext, HasContextAndHeaders headersContext, Map<String,String> params) Compiles (or retrieves from cache) and executes the provided script
static String	getScriptFromResponse(GetResponse responseFields)
void	putScriptToIndex(PutIndexedScriptRequest request, ActionListener<IndexResponse> listener)
void	queryScriptIndex(GetIndexedScriptRequest request, ActionListener<GetResponse> listener)
SearchScript	search(SearchLookup lookup, Script script, ScriptContext scriptContext, Map<String,String> params) Compiles (or retrieves from cache) and executes the provided search script
void	setClient(Client client)
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

DEFAULT_SCRIPTING_LANGUAGE_SETTING

public static final String DEFAULT_SCRIPTING_LANGUAGE_SETTING

See Also:

Constant Field Values

SCRIPT_CACHE_SIZE_SETTING

public static final String SCRIPT_CACHE_SIZE_SETTING

See Also:

Constant Field Values

SCRIPT_CACHE_SIZE_DEFAULT

public static final int SCRIPT_CACHE_SIZE_DEFAULT

See Also:

Constant Field Values

SCRIPT_CACHE_EXPIRE_SETTING

public static final String SCRIPT_CACHE_EXPIRE_SETTING

See Also:

Constant Field Values

SCRIPT_INDEX

public static final String SCRIPT_INDEX

See Also:

Constant Field Values

DEFAULT_LANG

public static final String DEFAULT_LANG

See Also:

Constant Field Values

SCRIPT_AUTO_RELOAD_ENABLED_SETTING

public static final String SCRIPT_AUTO_RELOAD_ENABLED_SETTING

See Also:

Constant Field Values

SCRIPT_LANG

@Deprecated
public static final ParseField SCRIPT_LANG

Deprecated. Use Script.ScriptField instead. This should be removed in 2.0

SCRIPT_FILE

@Deprecated
public static final ParseField SCRIPT_FILE

Deprecated. Use ScriptService.ScriptType.getParseField() instead. This should be removed in 2.0

SCRIPT_ID

@Deprecated
public static final ParseField SCRIPT_ID

Deprecated. Use ScriptService.ScriptType.getParseField() instead. This should be removed in 2.0

SCRIPT_INLINE

@Deprecated
public static final ParseField SCRIPT_INLINE

Deprecated. Use ScriptService.ScriptType.getParseField() instead. This should be removed in 2.0

Constructor Detail

ScriptService

@Inject
public ScriptService(Settings settings,
                    Environment env,
                    Set<ScriptEngineService> scriptEngines,
                    ResourceWatcherService resourceWatcherService,
                    ScriptContextRegistry scriptContextRegistry)
              throws IOException

Throws:

IOException

Method Detail

setClient

@Inject(optional=true)
public void setClient(Client client)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

compile

public CompiledScript compile(Script script,
                     ScriptContext scriptContext,
                     HasContextAndHeaders headersContext,
                     Map<String,String> params)

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

compileInternal

public CompiledScript compileInternal(Script script,
                             HasContextAndHeaders context,
                             Map<String,String> params)

Compiles a script straight-away, or returns the previously compiled and cached script, without checking if it can be executed based on settings.

queryScriptIndex

public void queryScriptIndex(GetIndexedScriptRequest request,
                    ActionListener<GetResponse> listener)

putScriptToIndex

public void putScriptToIndex(PutIndexedScriptRequest request,
                    ActionListener<IndexResponse> listener)

deleteScriptFromIndex

public void deleteScriptFromIndex(DeleteIndexedScriptRequest request,
                         ActionListener<DeleteResponse> listener)

getScriptFromResponse

public static String getScriptFromResponse(GetResponse responseFields)

executable

public ExecutableScript executable(Script script,
                          ScriptContext scriptContext,
                          HasContextAndHeaders headersContext,
                          Map<String,String> params)

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

executable

public ExecutableScript executable(CompiledScript compiledScript,
                          Map<String,Object> vars)

Executes a previously compiled script provided as an argument

search

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

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

stats

public ScriptStats stats()