org.apache.solr.handler.admin

Class ConfigSetsHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.ConfigSetsHandler

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider

public class ConfigSetsHandler
extends RequestHandlerBase
implements PermissionNameProvider

A SolrRequestHandler for ConfigSets API requests.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider

PermissionNameProvider.Name

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreContainer	coreContainer
static long	DEFAULT_ZK_TIMEOUT

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

appends, defaults, httpCaching, initArgs, invariants, solrMetricsContext

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Fields inherited from interface org.apache.solr.request.SolrRequestHandler

TYPE

Constructor Summary

Constructors

Constructor and Description
ConfigSetsHandler(CoreContainer coreContainer) Overloaded ctor to inject CoreContainer into the handler.

Method Summary

Modifier and Type	Method and Description
Collection<Api>	getApis() It is possible to support multiple v2 apis by a single requesthandler
SolrInfoBean.Category	getCategory() Category of this component
String	getDescription() Simple one or two line description
PermissionNameProvider.Name	getPermissionName(AuthorizationContext ctx)
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
Boolean	registerV2() Whether this request handler must be made available at the /v2/ path
protected void	sendToZk(SolrQueryResponse rsp, org.apache.solr.handler.admin.ConfigSetsHandler.ConfigSetOperation operation, Map<String,Object> result)

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getInitArgs, getMetricNames, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, initializeMetrics, setPluginInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getMetricRegistry, getMetricsSnapshot, registerMetricName

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close, getUniqueMetricTag, initializeMetrics

Methods inherited from interface org.apache.solr.api.ApiSupport

registerV1

Field Detail

coreContainer

protected final CoreContainer coreContainer

DEFAULT_ZK_TIMEOUT

public static long DEFAULT_ZK_TIMEOUT

Constructor Detail

ConfigSetsHandler

public ConfigSetsHandler(CoreContainer coreContainer)

Overloaded ctor to inject CoreContainer into the handler.

Parameters:

coreContainer - Core Container of the solr webapp installed.

Method Detail

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
                              SolrQueryResponse rsp)
                       throws Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

sendToZk

protected void sendToZk(SolrQueryResponse rsp,
                        org.apache.solr.handler.admin.ConfigSetsHandler.ConfigSetOperation operation,
                        Map<String,Object> result)
                 throws org.apache.zookeeper.KeeperException,
                        InterruptedException

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class RequestHandlerBase

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class RequestHandlerBase

getApis

public Collection<Api> getApis()

Description copied from interface: ApiSupport

It is possible to support multiple v2 apis by a single requesthandler

Specified by:

getApis in interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

Returns:

the list of v2 api implementations

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

Whether this request handler must be made available at the /v2/ path

Specified by:

registerV2 in interface ApiSupport

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

Specified by:

getPermissionName in interface PermissionNameProvider