org.elasticsearch.plugins
Interface Plugin

All Known Implementing Classes:

AbstractPlugin

public interface Plugin

An extension point allowing to plug in custom functionality.

Method Summary

java.lang.String	description() The description of the plugin.
java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.inject.Module>>	indexModules() Per index modules.
java.util.Collection<java.lang.Class<? extends CloseableIndexComponent>>	indexServices() Per index services that will be automatically closed.
java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.inject.Module>>	modules() Node level modules.
java.lang.String	name() The name of the plugin.
void	processModule(org.elasticsearch.common.inject.Module module)
java.util.Collection<java.lang.Class<? extends LifecycleComponent>>	services() Node level services that will be automatically started/stopped/closed.
java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.inject.Module>>	shardModules() Per index shard module.
java.util.Collection<java.lang.Class<? extends CloseableIndexComponent>>	shardServices() Per index shard service that will be automatically closed.

Method Detail

name

java.lang.String name()

The name of the plugin.

description

java.lang.String description()

The description of the plugin.

modules

java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.inject.Module>> modules()

Node level modules.

services

java.util.Collection<java.lang.Class<? extends LifecycleComponent>> services()

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

indexModules

java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.inject.Module>> indexModules()

Per index modules.

indexServices

java.util.Collection<java.lang.Class<? extends CloseableIndexComponent>> indexServices()

Per index services that will be automatically closed.

shardModules

java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.inject.Module>> shardModules()

Per index shard module.

shardServices

java.util.Collection<java.lang.Class<? extends CloseableIndexComponent>> shardServices()

Per index shard service that will be automatically closed.

processModule

void processModule(org.elasticsearch.common.inject.Module module)