org.elasticsearch.plugins

Class Plugin

java.lang.Object

org.elasticsearch.plugins.Plugin

public abstract class Plugin
extends java.lang.Object

An extension point allowing to plug in custom functionality. This class has a number of extension points that are available to all plugins, in addition you can implement any of the following interfaces to further customize Elasticsearch:

• ActionPlugin
• AnalysisPlugin
• ClusterPlugin
• DiscoveryPlugin
• IngestPlugin
• MapperPlugin
• RepositoryPlugin
• ScriptPlugin
• SearchPlugin

In addition to extension points this class also declares some @Deprecated public final void onModule methods. These methods should cause any extensions of Plugin that used the pre-5.x style extension syntax to fail to build and point the plugin author at the new extension syntax. We hope that these make the process of upgrading a plugin from 2.x to 5.x only mildly painful.

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
Settings	additionalSettings() Additional node settings loaded by the plugin.
java.util.Collection<java.lang.Object>	createComponents(Client client, ClusterService clusterService, ThreadPool threadPool, ResourceWatcherService resourceWatcherService, ScriptService scriptService, SearchRequestParsers searchRequestParsers) Returns components added by this plugin.
java.util.Collection<Module>	createGuiceModules() Node level guice modules.
java.util.function.UnaryOperator<java.util.Map<java.lang.String,MetaData.Custom>>	getCustomMetaDataUpgrader() Provides a function to modify global custom meta data on startup.
java.util.List<ExecutorBuilder<?>>	getExecutorBuilders(Settings settings) Provides the list of this plugin's custom thread pools, empty if none.
java.util.Collection<java.lang.Class<? extends LifecycleComponent>>	getGuiceServiceClasses() Node level services that will be automatically started/stopped/closed.
java.util.List<NamedWriteableRegistry.Entry>	getNamedWriteables() Returns parsers for NamedWriteable this plugin will use over the transport protocol.
java.util.List<Setting<?>>	getSettings() Returns a list of additional Setting definitions for this plugin.
java.util.List<java.lang.String>	getSettingsFilter() Returns a list of additional settings filter for this plugin
void	onIndexModule(IndexModule indexModule) Called before a new index is created on a node.
void	onModule(ActionModule module) Deprecated. implement ActionPlugin instead
void	onModule(AnalysisModule module) Deprecated. implement AnalysisPlugin instead
void	onModule(IndexModule indexModule) Deprecated. use #onIndexModule instead
void	onModule(ScriptModule module) Deprecated. implement ScriptPlugin instead
void	onModule(SearchModule module) Deprecated. implement SearchPlugin instead
void	onModule(SettingsModule settingsModule) Deprecated. use #getSettings and #getSettingsFilter instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Plugin

public Plugin()

Method Detail

createGuiceModules

public java.util.Collection<Module> createGuiceModules()

Node level guice modules.

getGuiceServiceClasses

public java.util.Collection<java.lang.Class<? extends LifecycleComponent>> getGuiceServiceClasses()

Node level services that will be automatically started/stopped/closed. This classes must be constructed by injection with guice.

createComponents

public java.util.Collection<java.lang.Object> createComponents(Client client,
                                                               ClusterService clusterService,
                                                               ThreadPool threadPool,
                                                               ResourceWatcherService resourceWatcherService,
                                                               ScriptService scriptService,
                                                               SearchRequestParsers searchRequestParsers)

Returns components added by this plugin. Any components returned that implement LifecycleComponent will have their lifecycle managed. Note: To aid in the migration away from guice, all objects returned as components will be bound in guice to themselves.

Parameters:

client - A client to make requests to the system

clusterService - A service to allow watching and updating cluster state

threadPool - A service to allow retrieving an executor to run an async action

resourceWatcherService - A service to watch for changes to node local files

scriptService - A service to allow running scripts on the local node

searchRequestParsers - Parsers for search requests which may be used to templatize search requests

additionalSettings

public Settings additionalSettings()

Additional node settings loaded by the plugin. Note that settings that are explicit in the nodes settings can't be overwritten with the additional settings. These settings added if they don't exist.

getNamedWriteables

public java.util.List<NamedWriteableRegistry.Entry> getNamedWriteables()

Returns parsers for NamedWriteable this plugin will use over the transport protocol.

See Also:

NamedWriteableRegistry

onIndexModule

public void onIndexModule(IndexModule indexModule)

Called before a new index is created on a node. The given module can be used to register index-level extensions.

getSettings

public java.util.List<Setting<?>> getSettings()

Returns a list of additional Setting definitions for this plugin.

getSettingsFilter

public java.util.List<java.lang.String> getSettingsFilter()

Returns a list of additional settings filter for this plugin

getCustomMetaDataUpgrader

public java.util.function.UnaryOperator<java.util.Map<java.lang.String,MetaData.Custom>> getCustomMetaDataUpgrader()

Provides a function to modify global custom meta data on startup.

Plugins should return the input custom map via UnaryOperator.identity() if no upgrade is required.

Returns:

Never null. The same or upgraded MetaData.Custom map.

Throws:

java.lang.IllegalStateException - if the node should not start because at least one MetaData.Custom is unsupported

getExecutorBuilders

public java.util.List<ExecutorBuilder<?>> getExecutorBuilders(Settings settings)

Provides the list of this plugin's custom thread pools, empty if none.

Parameters:

settings - the current settings

Returns:

executors builders for this plugin's custom thread pools

onModule

@Deprecated
public final void onModule(IndexModule indexModule)

Deprecated. use #onIndexModule instead

Old-style guice index level extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.

onModule

@Deprecated
public final void onModule(SettingsModule settingsModule)

Deprecated. use #getSettings and #getSettingsFilter instead

Old-style guice settings extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.

onModule

@Deprecated
public final void onModule(ScriptModule module)

Deprecated. implement ScriptPlugin instead

Old-style guice scripting extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.

onModule

@Deprecated
public final void onModule(AnalysisModule module)

Deprecated. implement AnalysisPlugin instead

Old-style analysis extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.

onModule

@Deprecated
public final void onModule(ActionModule module)

Deprecated. implement ActionPlugin instead

Old-style action extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.

onModule

@Deprecated
public final void onModule(SearchModule module)

Deprecated. implement SearchPlugin instead

Old-style action extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.