org.elasticsearch.plugins

Interface Plugin

All Known Implementing Classes:

AbstractPlugin

public interface Plugin

An extension point allowing to plug in custom functionality.

A plugin can be dynamically injected with Module by implementing onModule(AnyModule) method removing the need to override processModule(org.elasticsearch.common.inject.Module) and check using instanceof.

Method Summary

Modifier and Type	Method and Description
Settings	additionalSettings() Additional node settings loaded by the plugin
String	description() The description of the plugin.
Collection<Class<? extends Module>>	indexModules() Per index modules.
Collection<? extends Module>	indexModules(Settings settings) Per index modules.
Collection<Class<? extends CloseableIndexComponent>>	indexServices() Per index services that will be automatically closed.
Collection<Class<? extends Module>>	modules() Node level modules (classes, will automatically be created).
Collection<? extends Module>	modules(Settings settings) Node level modules (instances)
String	name() The name of the plugin.
void	processModule(Module module) Process a specific module.
Collection<Class<? extends LifecycleComponent>>	services() Node level services that will be automatically started/stopped/closed.
Collection<Class<? extends Module>>	shardModules() Per index shard module.
Collection<? extends Module>	shardModules(Settings settings) Per index shard module.
Collection<Class<? extends CloseableIndexComponent>>	shardServices() Per index shard service that will be automatically closed.

Method Detail

name

String name()

The name of the plugin.

description

String description()

The description of the plugin.

modules

Collection<Class<? extends Module>> modules()

Node level modules (classes, will automatically be created).

modules

Collection<? extends Module> modules(Settings settings)

Node level modules (instances)

Parameters:

settings - The node level settings.

services

Collection<Class<? extends LifecycleComponent>> services()

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

indexModules

Collection<Class<? extends Module>> indexModules()

Per index modules.

indexModules

Collection<? extends Module> indexModules(Settings settings)

Per index modules.

indexServices

Collection<Class<? extends CloseableIndexComponent>> indexServices()

Per index services that will be automatically closed.

shardModules

Collection<Class<? extends Module>> shardModules()

Per index shard module.

shardModules

Collection<? extends Module> shardModules(Settings settings)

Per index shard module.

shardServices

Collection<Class<? extends CloseableIndexComponent>> shardServices()

Per index shard service that will be automatically closed.

processModule

void processModule(Module module)

Process a specific module. Note, its simpler to implement a custom onModule(AnyModule module) method, which will be automatically be called by the relevant type.

additionalSettings

Settings additionalSettings()

Additional node settings loaded by the plugin