Package 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, ClusterStateApplier

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALLOW_NONE
static Setting<java.util.List<java.lang.String>>	CONTEXTS_ALLOWED_SETTING
static Setting<TimeValue>	SCRIPT_CACHE_EXPIRE_SETTING
static Setting<java.lang.Integer>	SCRIPT_CACHE_SIZE_SETTING
static Setting<Tuple<java.lang.Integer,TimeValue>>	SCRIPT_MAX_COMPILATIONS_RATE
static Setting<java.lang.Integer>	SCRIPT_MAX_SIZE_IN_BYTES
static Setting<java.util.List<java.lang.String>>	TYPES_ALLOWED_SETTING

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor	Description
ScriptService(Settings settings, java.util.Map<java.lang.String,ScriptEngine> engines, java.util.Map<java.lang.String,ScriptContext<?>> contexts)

Method Summary

Modifier and Type	Method	Description
void	applyClusterState(ClusterChangedEvent event)	Called when a new cluster state (ClusterChangedEvent.state() needs to be applied
void	close()
<FactoryType> FactoryType	compile(Script script, ScriptContext<FactoryType> context)	Compiles a script using the given context.
void	deleteStoredScript(ClusterService clusterService, DeleteStoredScriptRequest request, ActionListener<DeleteStoredScriptResponse> listener)
StoredScriptSource	getStoredScript(ClusterState state, GetStoredScriptRequest request)
boolean	isAnyContextEnabled()
boolean	isContextEnabled(ScriptContext scriptContext)
boolean	isLangSupported(java.lang.String lang)
boolean	isTypeEnabled(ScriptType scriptType)
void	putStoredScript(ClusterService clusterService, PutStoredScriptRequest request, ActionListener<PutStoredScriptResponse> listener)
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

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_MAX_SIZE_IN_BYTES

public static final Setting<java.lang.Integer> SCRIPT_MAX_SIZE_IN_BYTES

SCRIPT_MAX_COMPILATIONS_RATE

public static final Setting<Tuple<java.lang.Integer,TimeValue>> SCRIPT_MAX_COMPILATIONS_RATE

ALLOW_NONE

public static final java.lang.String ALLOW_NONE

See Also:

Constant Field Values

TYPES_ALLOWED_SETTING

public static final Setting<java.util.List<java.lang.String>> TYPES_ALLOWED_SETTING

CONTEXTS_ALLOWED_SETTING

public static final Setting<java.util.List<java.lang.String>> CONTEXTS_ALLOWED_SETTING

Constructor Detail

ScriptService

public ScriptService(Settings settings,
                     java.util.Map<java.lang.String,ScriptEngine> engines,
                     java.util.Map<java.lang.String,ScriptContext<?>> contexts)

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

compile

public <FactoryType> FactoryType compile(Script script,
                                         ScriptContext<FactoryType> context)

Compiles a script using the given context.

Returns:

a compiled script which may be used to construct instances of a script for the given context

isLangSupported

public boolean isLangSupported(java.lang.String lang)

isTypeEnabled

public boolean isTypeEnabled(ScriptType scriptType)

isContextEnabled

public boolean isContextEnabled(ScriptContext scriptContext)

isAnyContextEnabled

public boolean isAnyContextEnabled()

putStoredScript

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

deleteStoredScript

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

getStoredScript

public StoredScriptSource getStoredScript(ClusterState state,
                                          GetStoredScriptRequest request)

stats

public ScriptStats stats()

applyClusterState

public void applyClusterState(ClusterChangedEvent event)

Description copied from interface: ClusterStateApplier

Called when a new cluster state (ClusterChangedEvent.state() needs to be applied

Specified by:

applyClusterState in interface ClusterStateApplier