Scripting: remove deprecated methods from ScriptService
Removed the following methods from `ScriptService`, which don't require the `ScriptContext` argument: ``` public CompiledScript compile(String lang, String script, ScriptType scriptType) public ExecutableScript executable(String lang, String script, ScriptType scriptType, Map<String, Object> vars) public SearchScript search(SearchLookup lookup, String lang, String script, ScriptType scriptType, @Nullable Map<String, Object> vars) ``` Also removed the ScriptContext.Standard.GENERIC_PLUGIN enum value, as it was used only for backwards compatibility. Plugins that make use of scripts should declare their own script contexts through `ScriptModule#registerScriptContext` and use them when compiling/executing scripts. Closes #10476
This commit is contained in:
parent
7bd7ea8f13
commit
d9aebf4906
|
@ -344,6 +344,12 @@ Deprecated script parameters `id`, `file`, and `scriptField` have been removed
|
||||||
from all scriptable APIs. `script_id`, `script_file` and `script` should be used
|
from all scriptable APIs. `script_id`, `script_file` and `script` should be used
|
||||||
in their place.
|
in their place.
|
||||||
|
|
||||||
|
=== Plugins making use of scripts
|
||||||
|
|
||||||
|
Plugins that make use of scripts must register their own script context through
|
||||||
|
`ScriptModule`. Script contexts can be used as part of fine-grained settings to
|
||||||
|
enable/disable scripts selectively.
|
||||||
|
|
||||||
=== Thrift and memcached transport
|
=== Thrift and memcached transport
|
||||||
|
|
||||||
The thrift and memcached transport plugins are no longer supported. Instead, use
|
The thrift and memcached transport plugins are no longer supported. Instead, use
|
||||||
|
|
|
@ -38,14 +38,7 @@ public interface ScriptContext {
|
||||||
*/
|
*/
|
||||||
enum Standard implements ScriptContext {
|
enum Standard implements ScriptContext {
|
||||||
|
|
||||||
AGGS("aggs"), MAPPING("mapping"), SEARCH("search"), UPDATE("update"),
|
AGGS("aggs"), MAPPING("mapping"), SEARCH("search"), UPDATE("update");
|
||||||
/**
|
|
||||||
* Generic custom operation exposed via plugin
|
|
||||||
*
|
|
||||||
* @deprecated create a new {@link org.elasticsearch.script.ScriptContext.Plugin} instance instead
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
GENERIC_PLUGIN("plugin");
|
|
||||||
|
|
||||||
private final String key;
|
private final String key;
|
||||||
|
|
||||||
|
|
|
@ -214,18 +214,6 @@ public class ScriptService extends AbstractComponent implements Closeable {
|
||||||
return scriptEngineService;
|
return scriptEngineService;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.
|
|
||||||
* Doesn't require to specify a script context in order to maintain backwards compatibility, internally uses
|
|
||||||
* the {@link org.elasticsearch.script.ScriptContext.Standard#GENERIC_PLUGIN} default context, assuming that it can only be called from plugins.
|
|
||||||
*
|
|
||||||
* @deprecated use the method variant that accepts the {@link ScriptContext} argument too: {@link #compile(String, String, ScriptType, ScriptContext)}
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
public CompiledScript compile(String lang, String script, ScriptType scriptType) {
|
|
||||||
return compile(lang, script, scriptType, ScriptContext.Standard.GENERIC_PLUGIN);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.
|
* Checks if a script can be executed and compiles it if needed, or returns the previously compiled and cached script.
|
||||||
*/
|
*/
|
||||||
|
@ -394,18 +382,6 @@ public class ScriptService extends AbstractComponent implements Closeable {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Compiles (or retrieves from cache) and executes the provided script.
|
|
||||||
* Doesn't require to specify a script context in order to maintain backwards compatibility, internally uses
|
|
||||||
* the {@link org.elasticsearch.script.ScriptContext.Standard#GENERIC_PLUGIN} default context, assuming that it can only be called from plugins.
|
|
||||||
*
|
|
||||||
* @deprecated use the method variant that accepts the {@link ScriptContext} argument too: {@link #executable(String, String, ScriptType, ScriptContext, Map)}
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
public ExecutableScript executable(String lang, String script, ScriptType scriptType, Map<String, Object> vars) {
|
|
||||||
return executable(lang, script, scriptType, ScriptContext.Standard.GENERIC_PLUGIN, vars);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Compiles (or retrieves from cache) and executes the provided script
|
* Compiles (or retrieves from cache) and executes the provided script
|
||||||
*/
|
*/
|
||||||
|
@ -420,18 +396,6 @@ public class ScriptService extends AbstractComponent implements Closeable {
|
||||||
return getScriptEngineServiceForLang(compiledScript.lang()).executable(compiledScript.compiled(), vars);
|
return getScriptEngineServiceForLang(compiledScript.lang()).executable(compiledScript.compiled(), vars);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Compiles (or retrieves from cache) and executes the provided search script
|
|
||||||
* Doesn't require to specify a script context in order to maintain backwards compatibility, internally uses
|
|
||||||
* the {@link org.elasticsearch.script.ScriptContext.Standard#GENERIC_PLUGIN} default context, assuming that it can only be called from plugins.
|
|
||||||
*
|
|
||||||
* @deprecated use the method variant that accepts the {@link ScriptContext} argument too: {@link #search(SearchLookup, String, String, ScriptType, ScriptContext, Map)}
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
public SearchScript search(SearchLookup lookup, String lang, String script, ScriptType scriptType, @Nullable Map<String, Object> vars) {
|
|
||||||
return search(lookup, lang, script, scriptType, ScriptContext.Standard.GENERIC_PLUGIN, vars);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Compiles (or retrieves from cache) and executes the provided search script
|
* Compiles (or retrieves from cache) and executes the provided search script
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue