Package org.apache.solr.api

Class ZkClusterPluginsSource

java.lang.Object

org.apache.solr.api.ZkClusterPluginsSource

All Implemented Interfaces:

ClusterPluginsSource

public class ZkClusterPluginsSource
extends Object
implements ClusterPluginsSource

The plugin configurations are stored and retrieved from the ZooKeeper cluster properties, stored at the ZkStateReader.CONTAINER_PLUGINS location This supports mutable configurations, and management via the /cluster/plugin APIs

Constructor Summary

Constructors

Constructor	Description
ZkClusterPluginsSource(CoreContainer coreContainer)

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
void	persistPlugins(Function<Map<String,Object>,Map<String,Object>> modifier)	Persist the updated set of plugin configs
Map<String,Object>	plugins()	Retrieve the current plugin configurations.

Methods inherited from class java.lang.Object

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

Constructor Details

ZkClusterPluginsSource

public ZkClusterPluginsSource(CoreContainer coreContainer)

Method Details

getReadApi

public ContainerPluginsApi.Read getReadApi()

Description copied from interface: ClusterPluginsSource

Get the Read Api for this plugin source

Specified by:

getReadApi in interface ClusterPluginsSource

Returns:

A ContainerPluginsApi Read Api for this plugin source

getEditApi

public ContainerPluginsApi.Edit getEditApi()

Description copied from interface: ClusterPluginsSource

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

Specified by:

getEditApi in interface ClusterPluginsSource

Returns:

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

plugins

public Map<String,Object> plugins()
                           throws IOException

Retrieve the current plugin configurations.

Specified by:

plugins in interface ClusterPluginsSource

Returns:

current plugin configurations, where keys are plugin names and values are PluginMeta plugin metadata.

Throws:

IOException - on IO errors

persistPlugins

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

Description copied from interface: ClusterPluginsSource

Persist the updated set of plugin configs

Specified by:

persistPlugins in interface ClusterPluginsSource

Parameters:

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

Throws:

IOException