Package 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 class org.apache.solr.handler.RequestHandlerBase

RequestHandlerBase.HandlerMetrics

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	Description
static final String	AUTOCREATED_CONFIGSET_SUFFIX
static long	CONFIG_SET_TIMEOUT
protected final CoreContainer	coreContainer
static final String	DEFAULT_CONFIGSET_NAME

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

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

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

ANY, NULL, values

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

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

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

TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	checkErrors()
Collection<Api>	getApis()	Returns any (non-JAX-RS annotated) APIs associated with this request handler.
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
Collection<Class<? extends JerseyResource>>	getJerseyResources()	Returns any JAX-RS annotated v2 APIs associated with this request handler.
PermissionNameProvider.Name	getPermissionName(AuthorizationContext ctx)
static String	getSuffixedNameForAutoGeneratedConfigSet(String configName)
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
static boolean	isAutoGeneratedConfigSet(String configName)
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path

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

getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, initializeMetrics, isInternalShardRequest, processErrorMetricsOnException, processReceivedException, 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.api.ApiSupport

registerV1

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

close

Field Details

DEFAULT_CONFIGSET_NAME

public static final String DEFAULT_CONFIGSET_NAME

See Also:

• Constant Field Values

AUTOCREATED_CONFIGSET_SUFFIX

public static final String AUTOCREATED_CONFIGSET_SUFFIX

See Also:

• Constant Field Values

coreContainer

protected final CoreContainer coreContainer

CONFIG_SET_TIMEOUT

public static long CONFIG_SET_TIMEOUT

Constructor Details

ConfigSetsHandler

public ConfigSetsHandler(CoreContainer coreContainer)

Overloaded ctor to inject CoreContainer into the handler.

Parameters:

coreContainer - Core Container of the solr webapp installed.

Method Details

getSuffixedNameForAutoGeneratedConfigSet

public static String getSuffixedNameForAutoGeneratedConfigSet(String configName)

isAutoGeneratedConfigSet

public static boolean isAutoGeneratedConfigSet(String configName)

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

checkErrors

protected void checkErrors()

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

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

getApis

public Collection<Api> getApis()

Description copied from interface: ApiSupport

Returns any (non-JAX-RS annotated) APIs associated with this request handler.

Specified by:

getApis in interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

See Also:

• ApiSupport.getJerseyResources()

getJerseyResources

public Collection<Class<? extends JerseyResource>> getJerseyResources()

Description copied from interface: ApiSupport

Returns any JAX-RS annotated v2 APIs associated with this request handler.

Specified by:

getJerseyResources in interface ApiSupport

See Also:

• ApiSupport.getApis()

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

Specified by:

getPermissionName in interface PermissionNameProvider