Plugin (core 5.2.0 API)

java.lang.Object
- org.elasticsearch.plugins.Plugin

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public abstract class Plugin
extends java.lang.Object
implements java.io.Closeable
```
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:
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()

Constructors
Constructor and Description
`Plugin()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Settings`	`additionalSettings()` Additional node settings loaded by the plugin.
`void`	`close()` Close the resources opened by this plugin.
`java.util.Collection<java.lang.Object>`	`createComponents(Client client, ClusterService clusterService, ThreadPool threadPool, ResourceWatcherService resourceWatcherService, ScriptService scriptService, SearchRequestParsers searchRequestParsers, NamedXContentRegistry xContentRegistry)` Returns components added by this plugin.
`java.util.Collection<Module>`	`createGuiceModules()` Node level guice modules.
`java.util.List<BootstrapCheck>`	`getBootstrapChecks()` Returns a list of checks that are enforced when a node starts up once a node has the transport protocol bound to a non-loopback interface.
`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<NamedXContentRegistry.Entry>`	`getNamedXContent()` Returns parsers for named objects this plugin will parse from `XContentParser.namedObject(Class, String, Object)`.
`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(ClusterModule module)` Deprecated. implement `ClusterPlugin` instead
`void`	`onModule(DiscoveryModule module)` Deprecated. implement `DiscoveryPlugin` instead
`void`	`onModule(IndexModule indexModule)` Deprecated. use #onIndexModule instead
`void`	`onModule(NetworkModule module)` Deprecated. implement `NetworkPlugin` instead
`void`	`onModule(RepositoriesModule module)` Deprecated. implement `RepositoryPlugin` 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,
                                                               NamedXContentRegistry xContentRegistry)
```
    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
  - getNamedXContent
```
public java.util.List<NamedXContentRegistry.Entry> getNamedXContent()
```
    Returns parsers for named objects this plugin will parse from XContentParser.namedObject(Class, String, Object).
    
    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
  - getBootstrapChecks
```
public java.util.List<BootstrapCheck> getBootstrapChecks()
```
    Returns a list of checks that are enforced when a node starts up once a node has the transport protocol bound to a non-loopback interface. In this case we assume the node is running in production and all bootstrap checks must pass. This allows plugins to provide a better out of the box experience by pre-configuring otherwise (in production) mandatory settings or to enforce certain configurations like OS settings or 3rd party resources.
  - close
```
public void close()
           throws java.io.IOException
```
    Close the resources opened by this plugin.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException - if the plugin failed to close its resources
  - 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 search extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.
  - onModule
```
@Deprecated
public final void onModule(NetworkModule module)
```
    Deprecated. implement NetworkPlugin instead
    
    Old-style network extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.
  - onModule
```
@Deprecated
public final void onModule(RepositoriesModule module)
```
    Deprecated. implement RepositoryPlugin instead
    
    Old-style snapshot/restore extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.
  - onModule
```
@Deprecated
public final void onModule(ClusterModule module)
```
    Deprecated. implement ClusterPlugin instead
    
    Old-style cluster extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.
  - onModule
```
@Deprecated
public final void onModule(DiscoveryModule module)
```
    Deprecated. implement DiscoveryPlugin instead
    
    Old-style discovery extension point. @Deprecated and final to act as a signpost for plugin authors upgrading from 2.x.

Class Plugin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Plugin

Method Detail

createGuiceModules

getGuiceServiceClasses

createComponents

additionalSettings

getNamedWriteables

getNamedXContent

onIndexModule

getSettings

getSettingsFilter

getCustomMetaDataUpgrader

getExecutorBuilders

getBootstrapChecks

close

onModule

onModule

onModule

onModule

onModule

onModule

onModule

onModule

onModule

onModule