Package org.elasticsearch.plugins

Class PluginsService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.plugins.PluginsService

public class PluginsService
extends AbstractComponent

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<java.util.List<java.lang.String>>	MANDATORY_SETTING

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor	Description
PluginsService(Settings settings, java.nio.file.Path configPath, java.nio.file.Path modulesDirectory, java.nio.file.Path pluginsDirectory, java.util.Collection<java.lang.Class<? extends Plugin>> classpathPlugins)	Constructs a new PluginService

Method Summary

Modifier and Type	Method	Description
java.util.Collection<Module>	createGuiceModules()
<T> java.util.List<T>	filterPlugins(java.lang.Class<T> type)
static java.util.List<java.nio.file.Path>	findPluginDirs(java.nio.file.Path rootPath)	Extracts all installed plugin directories from the provided rootPath expanding meta-plugins if needed.
java.util.List<ExecutorBuilder<?>>	getExecutorBuilders(Settings settings)
java.util.Collection<java.lang.Class<? extends LifecycleComponent>>	getGuiceServiceClasses()	Returns all classes injected into guice by plugins which extend LifecycleComponent.
java.util.List<Setting<?>>	getPluginSettings()
java.util.List<java.lang.String>	getPluginSettingsFilter()
PluginsAndModules	info()	Get information about plugins and modules
void	onIndexModule(IndexModule indexModule)
Settings	updatedSettings()

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

MANDATORY_SETTING

public static final Setting<java.util.List<java.lang.String>> MANDATORY_SETTING

Constructor Detail

PluginsService

public PluginsService(Settings settings,
                      java.nio.file.Path configPath,
                      java.nio.file.Path modulesDirectory,
                      java.nio.file.Path pluginsDirectory,
                      java.util.Collection<java.lang.Class<? extends Plugin>> classpathPlugins)

Constructs a new PluginService

Parameters:

settings - The settings of the system

modulesDirectory - The directory modules exist in, or null if modules should not be loaded from the filesystem

pluginsDirectory - The directory plugins exist in, or null if plugins should not be loaded from the filesystem

classpathPlugins - Plugins that exist in the classpath which should be loaded

Method Detail

getPluginSettings

public java.util.List<Setting<?>> getPluginSettings()

getPluginSettingsFilter

public java.util.List<java.lang.String> getPluginSettingsFilter()

updatedSettings

public Settings updatedSettings()

createGuiceModules

public java.util.Collection<Module> createGuiceModules()

getExecutorBuilders

public java.util.List<ExecutorBuilder<?>> getExecutorBuilders(Settings settings)

getGuiceServiceClasses

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

Returns all classes injected into guice by plugins which extend LifecycleComponent.

onIndexModule

public void onIndexModule(IndexModule indexModule)

info

public PluginsAndModules info()

Get information about plugins and modules

findPluginDirs

public static java.util.List<java.nio.file.Path> findPluginDirs(java.nio.file.Path rootPath)
                                                         throws java.io.IOException

Extracts all installed plugin directories from the provided rootPath expanding meta-plugins if needed.

Parameters:

rootPath - the path where the plugins are installed

Returns:

a list of all plugin paths installed in the rootPath

Throws:

java.io.IOException - if an I/O exception occurred reading the directories

filterPlugins

public <T> java.util.List<T> filterPlugins(java.lang.Class<T> type)