Package org.elasticsearch.plugins

Interface ActionPlugin

public interface ActionPlugin

An additional extension point for Plugins that extends Elasticsearch's scripting functionality. Implement it like this:

   {@literal @}Override
   public List<ActionHandler<?, ?>> getActions() {
       return Arrays.asList(new ActionHandler<>(ReindexAction.INSTANCE, TransportReindexAction.class),
               new ActionHandler<>(UpdateByQueryAction.INSTANCE, TransportUpdateByQueryAction.class),
               new ActionHandler<>(DeleteByQueryAction.INSTANCE, TransportDeleteByQueryAction.class),
               new ActionHandler<>(RethrottleAction.INSTANCE, TransportRethrottleAction.class));
   }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActionPlugin.ActionHandler<Request extends ActionRequest,Response extends ActionResponse>

Method Summary

Modifier and Type	Method	Description
default java.util.List<ActionFilter>	getActionFilters()	Action filters added by this plugin.
default java.util.List<ActionPlugin.ActionHandler<? extends ActionRequest,? extends ActionResponse>>	getActions()	Actions added by this plugin.
default java.util.List<GenericAction>	getClientActions()	Client actions added by this plugin.
default java.util.List<RestHandler>	getRestHandlers(Settings settings, RestController restController, ClusterSettings clusterSettings, IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver, java.util.function.Supplier<DiscoveryNodes> nodesInCluster)	Rest handlers added by this plugin.
default java.util.function.UnaryOperator<RestHandler>	getRestHandlerWrapper(ThreadContext threadContext)	Returns a function used to wrap each rest request before handling the request.
default java.util.Collection<java.lang.String>	getRestHeaders()	Returns headers which should be copied through rest requests on to internal requests.
default java.util.Collection<java.lang.String>	getTaskHeaders()	Returns headers which should be copied from internal requests into tasks.

Method Detail

getActions

default java.util.List<ActionPlugin.ActionHandler<? extends ActionRequest,? extends ActionResponse>> getActions()

Actions added by this plugin.

getClientActions

default java.util.List<GenericAction> getClientActions()

Client actions added by this plugin. This defaults to all of the GenericAction in getActions().

getActionFilters

default java.util.List<ActionFilter> getActionFilters()

Action filters added by this plugin.

getRestHandlers

default java.util.List<RestHandler> getRestHandlers(Settings settings,
                                                    RestController restController,
                                                    ClusterSettings clusterSettings,
                                                    IndexScopedSettings indexScopedSettings,
                                                    SettingsFilter settingsFilter,
                                                    IndexNameExpressionResolver indexNameExpressionResolver,
                                                    java.util.function.Supplier<DiscoveryNodes> nodesInCluster)

Rest handlers added by this plugin.

getRestHeaders

default java.util.Collection<java.lang.String> getRestHeaders()

Returns headers which should be copied through rest requests on to internal requests.

getTaskHeaders

default java.util.Collection<java.lang.String> getTaskHeaders()

Returns headers which should be copied from internal requests into tasks.

getRestHandlerWrapper

default java.util.function.UnaryOperator<RestHandler> getRestHandlerWrapper(ThreadContext threadContext)

Returns a function used to wrap each rest request before handling the request. Note: Only one installed plugin may implement a rest wrapper.