org.elasticsearch.plugins

Class Plugin

java.lang.Object

org.elasticsearch.plugins.Plugin

public abstract class Plugin
extends Object

An extension point allowing to plug in custom functionality.

A plugin can be register custom extensions to builtin behavior by implementing onModule(AnyModule), and registering the extension with the given module.

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Methods

Modifier and Type	Method and Description
Settings	additionalSettings() Additional node settings loaded by the plugin.
abstract String	description() The description of the plugin.
Collection<Module>	indexModules(Settings indexSettings) Per index modules.
Collection<Class<? extends Closeable>>	indexServices() Per index services that will be automatically closed.
abstract String	name() The name of the plugin.
Collection<Module>	nodeModules() Node level modules.
Collection<Class<? extends LifecycleComponent>>	nodeServices() Node level services that will be automatically started/stopped/closed.
Collection<Module>	shardModules(Settings indexSettings) Per index shard module.
Collection<Class<? extends Closeable>>	shardServices() Per index shard service that will be automatically closed.

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

name

public abstract String name()

The name of the plugin.

description

public abstract String description()

The description of the plugin.

nodeModules

public Collection<Module> nodeModules()

Node level modules.

nodeServices

public Collection<Class<? extends LifecycleComponent>> nodeServices()

Node level services that will be automatically started/stopped/closed.

indexModules

public Collection<Module> indexModules(Settings indexSettings)

Per index modules.

indexServices

public Collection<Class<? extends Closeable>> indexServices()

Per index services that will be automatically closed.

shardModules

public Collection<Module> shardModules(Settings indexSettings)

Per index shard module.

shardServices

public Collection<Class<? extends Closeable>> shardServices()

Per index shard service that will be automatically closed.

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.