org.elasticsearch.script.mustache

Class MustacheScriptEngineService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.script.mustache.MustacheScriptEngineService

All Implemented Interfaces:

Closeable, AutoCloseable, ScriptEngineService

public class MustacheScriptEngineService
extends AbstractComponent
implements ScriptEngineService

Main entry point handling template registration, compilation and execution. Template handling is based on Mustache. Template handling is a two step process: First compile the string representing the template, the resulting Mustache object can then be re-used for subsequent executions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

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

componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
MustacheScriptEngineService(Settings settings)

Method Summary

Modifier and Type	Method and Description
void	close()
Object	compile(String template) Compile a template string to (in this case) a Mustache object than can later be re-used for execution to fill in missing parameter values.
ExecutableScript	executable(Object mustache, Map<String,Object> vars)
Object	execute(Object template, Map<String,Object> vars) Execute a compiled template object (as retrieved from the compile method) and fill potential place holders with the variables given.
String[]	extensions()
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

Constructor Detail

MustacheScriptEngineService

@Inject
public MustacheScriptEngineService(Settings settings)

Parameters:

settings - automatically wired by Guice.

Method Detail

compile

public Object compile(String template)

Compile a template string to (in this case) a Mustache object than can later be re-used for execution to fill in missing parameter values.

Specified by:

compile in interface ScriptEngineService

Parameters:

template - a string representing the template to compile.

Returns:

a compiled template object for later execution.

execute

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

Execute a compiled template object (as retrieved from the compile method) and fill potential place holders with the variables given.

Specified by:

execute in interface ScriptEngineService

Parameters:

template - compiled template object.

vars - map of variables to use during substitution.

Returns:

the processed string with all given variables substitued.

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

executable

public ExecutableScript executable(Object mustache,
                                   @Nullable
                                   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

unwrap

public Object unwrap(Object value)

Specified by:

unwrap in interface ScriptEngineService

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

scriptRemoved

public void scriptRemoved(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