Package org.apache.solr.api

Interface ClusterPluginsSource

All Known Implementing Classes:

NodeConfigClusterPluginsSource, ZkClusterPluginsSource

public interface ClusterPluginsSource

A source for Cluster Plugin configurations

Method Summary

Modifier and Type	Method	Description
ContainerPluginsApi.Edit	getEditApi()	Get the Edit Api for this plugin source, if it supports edit operations
ContainerPluginsApi.Read	getReadApi()	Get the Read Api for this plugin source
static ClusterPluginsSource	loadClusterPluginsSource(CoreContainer cc, SolrResourceLoader loader)
void	persistPlugins(Function<Map<String,Object>,Map<String,Object>> modifier)	Persist the updated set of plugin configs
Map<String,Object>	plugins()	Get a map of cluster plugin configurations from this source, where keys are plugin names and values are PluginMeta plugin metadata.
static String	resolveClassName()	Resolves the name of the class that will be used to provide cluster plugins.

Method Detail

resolveClassName

static String resolveClassName()

Resolves the name of the class that will be used to provide cluster plugins.

Returns:

The name of the class to use as the ClusterPluginsSource

loadClusterPluginsSource

static ClusterPluginsSource loadClusterPluginsSource(CoreContainer cc,
                                                     SolrResourceLoader loader)

getReadApi

ContainerPluginsApi.Read getReadApi()

Get the Read Api for this plugin source

Returns:

A ContainerPluginsApi Read Api for this plugin source

getEditApi

ContainerPluginsApi.Edit getEditApi()

Get the Edit Api for this plugin source, if it supports edit operations

Returns:

A ContainerPluginsApi Edit Api for this plugin source, or null if the plugin source does not support editing the plugin configs

plugins

Map<String,Object> plugins()
                          throws IOException

Get a map of cluster plugin configurations from this source, where keys are plugin names and values are PluginMeta plugin metadata.

Returns:

An immutable map of plugin configurations

Throws:

IOException

persistPlugins

void persistPlugins(Function<Map<String,Object>,Map<String,Object>> modifier)
             throws IOException

Persist the updated set of plugin configs

Parameters:

modifier - A function providing the map of plugin configs to be persisted

Throws:

IOException