org.elasticsearch.script.groovy

Class GroovyScriptEngineService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.script.groovy.GroovyScriptEngineService

All Implemented Interfaces:

Closeable, AutoCloseable, ScriptEngineService

public class GroovyScriptEngineService
extends AbstractComponent
implements ScriptEngineService

Provides the infrastructure for Groovy as a scripting language for Elasticsearch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroovyScriptEngineService.GroovyScript

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROOVY_SCRIPT_BLACKLIST_PATCH
static String	GROOVY_SCRIPT_SANDBOX_ENABLED
static String	NAME

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

componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
GroovyScriptEngineService(Settings settings)

Method Summary

Modifier and Type	Method and Description
boolean	addToBlacklist(String... additions) Appends the additional blacklisted methods to the current blacklist, returns true if the black list has changed
Set<String>	blacklistAdditions()
void	close()
Object	compile(String script)
ExecutableScript	executable(Object compiledScript, Map<String,Object> vars)
Object	execute(Object compiledScript, Map<String,Object> vars)
String[]	extensions()
void	reloadConfig()
boolean	sandboxed()
void	scriptRemoved(CompiledScript script) Handler method called when a script is removed from the Guava cache.
SearchScript	search(Object compiledScript, SearchLookup lookup, Map<String,Object> vars)
String[]	types()
Object	unwrap(Object value)

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

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 String NAME

See Also:

Constant Field Values

GROOVY_SCRIPT_SANDBOX_ENABLED

public static String GROOVY_SCRIPT_SANDBOX_ENABLED

GROOVY_SCRIPT_BLACKLIST_PATCH

public static String GROOVY_SCRIPT_BLACKLIST_PATCH

Constructor Detail

GroovyScriptEngineService

@Inject
public GroovyScriptEngineService(Settings settings)

Method Detail

blacklistAdditions

public Set<String> blacklistAdditions()

addToBlacklist

public boolean addToBlacklist(String... additions)

Appends the additional blacklisted methods to the current blacklist, returns true if the black list has changed

reloadConfig

public void reloadConfig()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

scriptRemoved

public void scriptRemoved(@Nullable
                          CompiledScript script)

Description copied from interface: ScriptEngineService

Handler method called when a script is removed from the Guava cache. The passed script may be null if it has already been garbage collected.

Specified by:

scriptRemoved in interface ScriptEngineService

types

public String[] types()

Specified by:

types in interface ScriptEngineService

extensions

public String[] extensions()

Specified by:

extensions in interface ScriptEngineService

sandboxed

public boolean sandboxed()

Specified by:

sandboxed in interface ScriptEngineService

compile

public Object compile(String script)

Specified by:

compile in interface ScriptEngineService

executable

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

Specified by:

executable in interface ScriptEngineService

search

public SearchScript search(Object compiledScript,
                           SearchLookup lookup,
                           @Nullable
                           Map<String,Object> vars)

Specified by:

search in interface ScriptEngineService

execute

public Object execute(Object compiledScript,
                      Map<String,Object> vars)

Specified by:

execute in interface ScriptEngineService

unwrap

public Object unwrap(Object value)

Specified by:

unwrap in interface ScriptEngineService