org.elasticsearch.plugins

Class AbstractPlugin

java.lang.Object

org.elasticsearch.plugins.AbstractPlugin

All Implemented Interfaces:

Plugin

public abstract class AbstractPlugin
extends Object
implements Plugin

A base class for a plugin.

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.

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Modifier and Type	Method and Description
Settings	additionalSettings() Additional node settings loaded by the plugin
Collection<Class<? extends Module>>	indexModules() Defaults to return an empty list.
Collection<Module>	indexModules(Settings settings) Defaults to return an empty list.
Collection<Class<? extends CloseableIndexComponent>>	indexServices() Defaults to return an empty list.
Collection<Class<? extends Module>>	modules() Defaults to return an empty list.
Collection<Module>	modules(Settings settings) Defaults to return an empty list.
void	processModule(Module module) Process a specific module.
Collection<Class<? extends LifecycleComponent>>	services() Defaults to return an empty list.
Collection<Class<? extends Module>>	shardModules() Defaults to return an empty list.
Collection<Module>	shardModules(Settings settings) Defaults to return an empty list.
Collection<Class<? extends CloseableIndexComponent>>	shardServices() Defaults to return an empty list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.plugins.Plugin

description, name

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

modules

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

Defaults to return an empty list.

Specified by:

modules in interface Plugin

modules

public Collection<Module> modules(Settings settings)

Defaults to return an empty list.

Specified by:

modules in interface Plugin

Parameters:

settings - The node level settings.

services

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

Defaults to return an empty list.

Specified by:

services in interface Plugin

indexModules

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

Defaults to return an empty list.

Specified by:

indexModules in interface Plugin

indexModules

public Collection<Module> indexModules(Settings settings)

Defaults to return an empty list.

Specified by:

indexModules in interface Plugin

indexServices

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

Defaults to return an empty list.

Specified by:

indexServices in interface Plugin

shardModules

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

Defaults to return an empty list.

Specified by:

shardModules in interface Plugin

shardModules

public Collection<Module> shardModules(Settings settings)

Defaults to return an empty list.

Specified by:

shardModules in interface Plugin

shardServices

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

Defaults to return an empty list.

Specified by:

shardServices in interface Plugin

processModule

public void processModule(Module module)

Description copied from interface: Plugin

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.

Specified by:

processModule in interface Plugin

additionalSettings

public Settings additionalSettings()

Description copied from interface: Plugin

Additional node settings loaded by the plugin

Specified by:

additionalSettings in interface Plugin