|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Plugin
An extension point allowing to plug in custom functionality.
A plugin can be dynamically injected withModule
by implementing onModule(AnyModule) method
removing the need to override processModule(org.elasticsearch.common.inject.Module)
and check using
instanceof.
Method Summary | |
---|---|
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 |
---|
String name()
String description()
Collection<Class<? extends Module>> modules()
Collection<? extends Module> modules(Settings settings)
settings
- The node level settings.Collection<Class<? extends LifecycleComponent>> services()
Collection<Class<? extends Module>> indexModules()
Collection<? extends Module> indexModules(Settings settings)
Collection<Class<? extends CloseableIndexComponent>> indexServices()
Collection<Class<? extends Module>> shardModules()
Collection<? extends Module> shardModules(Settings settings)
Collection<Class<? extends CloseableIndexComponent>> shardServices()
void processModule(Module module)
Settings additionalSettings()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |