org.elasticsearch.script.mustache

Class MustacheScriptEngineService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.script.mustache.MustacheScriptEngineService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.elasticsearch.script.ScriptEngineService

public final class MustacheScriptEngineService
extends org.elasticsearch.common.component.AbstractComponent
implements org.elasticsearch.script.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 java.lang.String	NAME

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
MustacheScriptEngineService(org.elasticsearch.common.settings.Settings settings)

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.Object	compile(java.lang.String templateName, java.lang.String templateSource, java.util.Map<java.lang.String,java.lang.String> params) 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.
org.elasticsearch.script.ExecutableScript	executable(org.elasticsearch.script.CompiledScript compiledScript, java.util.Map<java.lang.String,java.lang.Object> vars)
java.lang.String	getExtension()
java.lang.String	getType()
boolean	isInlineScriptEnabled()
org.elasticsearch.script.SearchScript	search(org.elasticsearch.script.CompiledScript compiledScript, org.elasticsearch.search.lookup.SearchLookup lookup, java.util.Map<java.lang.String,java.lang.Object> vars)

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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

MustacheScriptEngineService

public MustacheScriptEngineService(org.elasticsearch.common.settings.Settings settings)

Parameters:

settings - automatically wired by Guice.

Method Detail

compile

public java.lang.Object compile(java.lang.String templateName,
                                java.lang.String templateSource,
                                java.util.Map<java.lang.String,java.lang.String> params)

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 org.elasticsearch.script.ScriptEngineService

Parameters:

templateSource - a string representing the template to compile.

Returns:

a compiled template object for later execution.

getType

public java.lang.String getType()

Specified by:

getType in interface org.elasticsearch.script.ScriptEngineService

getExtension

public java.lang.String getExtension()

Specified by:

getExtension in interface org.elasticsearch.script.ScriptEngineService

executable

public org.elasticsearch.script.ExecutableScript executable(org.elasticsearch.script.CompiledScript compiledScript,
                                                            @Nullable
                                                            java.util.Map<java.lang.String,java.lang.Object> vars)

Specified by:

executable in interface org.elasticsearch.script.ScriptEngineService

search

public org.elasticsearch.script.SearchScript search(org.elasticsearch.script.CompiledScript compiledScript,
                                                    org.elasticsearch.search.lookup.SearchLookup lookup,
                                                    @Nullable
                                                    java.util.Map<java.lang.String,java.lang.Object> vars)

Specified by:

search in interface org.elasticsearch.script.ScriptEngineService

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isInlineScriptEnabled

public boolean isInlineScriptEnabled()

Specified by:

isInlineScriptEnabled in interface org.elasticsearch.script.ScriptEngineService