io.crate

Interface Plugin

All Known Implementing Classes:

AbstractPlugin

public interface Plugin

An extension point allowing to plug in custom functionality.

A plugin may implement a constructor with a Settings argument, which will be called preferred to an empty one.

Method Summary

Modifier and Type	Method and Description
org.elasticsearch.common.settings.Settings	additionalSettings() Additional node settings loaded by the plugin
java.lang.String	description() The description of the plugin.
java.util.Collection<? extends org.elasticsearch.common.inject.Module>	indexModules(org.elasticsearch.common.settings.Settings settings) Per index modules.
java.util.Collection<java.lang.Class<? extends java.io.Closeable>>	indexServices() Per index services that will be automatically closed.
java.lang.String	name() The name of the plugin.
java.util.Collection<org.elasticsearch.common.inject.Module>	nodeModules() Node level modules.
java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.component.LifecycleComponent>>	nodeServices() Node level services that will be automatically started/stopped/closed.
void	processModule(org.elasticsearch.common.inject.Module module) Process a specific module.
java.util.Collection<? extends org.elasticsearch.common.inject.Module>	shardModules(org.elasticsearch.common.settings.Settings settings) Per index shard module.
java.util.Collection<java.lang.Class<? extends java.io.Closeable>>	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.

nodeModules

java.util.Collection<org.elasticsearch.common.inject.Module> nodeModules()

Node level modules.

nodeServices

java.util.Collection<java.lang.Class<? extends org.elasticsearch.common.component.LifecycleComponent>> nodeServices()

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

indexModules

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

Per index modules.

indexServices

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

Per index services that will be automatically closed.

shardModules

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

Per index shard module.

shardServices

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

Per index shard service that will be automatically closed.

processModule

void processModule(org.elasticsearch.common.inject.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

org.elasticsearch.common.settings.Settings additionalSettings()

Additional node settings loaded by the plugin