Package org.apache.solr.handler

Class SolrConfigHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.SolrConfigHandler

All Implemented Interfaces:

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

public class SolrConfigHandler
extends RequestHandlerBase
implements SolrCoreAware, PermissionNameProvider

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	CONFIG_EDITING_ENABLED_ARG
static final boolean	configEditingEnabled
static final String	CREATE
static final String	SET
static final String	SET_PROPERTY
static final String	SET_USER_PROPERTY
static final String	UNSET_PROPERTY
static final String	UNSET_USER_PROPERTY
static final String	UPDATE

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
SolrConfigHandler()

Method Summary

Modifier and Type	Method	Description
static List<org.apache.solr.common.cloud.Replica>	getActiveReplicas(ZkController zkController, String collection)
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
static boolean	getImmutable(SolrCore core)
PermissionNameProvider.Name	getPermissionName(AuthorizationContext ctx)
Lock	getReloadLock()
SolrRequestHandler	getSubHandler(String path)	Return a RequestHandler to handle a subpath from the path this handler is registered.
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
void	inform(SolrCore core)
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path
static String	validateName(String s)

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

getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, 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

getJerseyResources, registerV1

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

close

Field Details

CONFIG_EDITING_ENABLED_ARG

public static final String CONFIG_EDITING_ENABLED_ARG

See Also:

• Constant Field Values

configEditingEnabled

public static final boolean configEditingEnabled

SET_PROPERTY

public static final String SET_PROPERTY

See Also:

• Constant Field Values

UNSET_PROPERTY

public static final String UNSET_PROPERTY

See Also:

• Constant Field Values

SET_USER_PROPERTY

public static final String SET_USER_PROPERTY

See Also:

• Constant Field Values

UNSET_USER_PROPERTY

public static final String UNSET_USER_PROPERTY

See Also:

• Constant Field Values

SET

public static final String SET

See Also:

• Constant Field Values

UPDATE

public static final String UPDATE

See Also:

• Constant Field Values

CREATE

public static final String CREATE

See Also:

• Constant Field Values

Constructor Details

SolrConfigHandler

public SolrConfigHandler()

Method Details

getReloadLock

public Lock getReloadLock()

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

getImmutable

public static boolean getImmutable(SolrCore core)

validateName

public static String validateName(String s)

getSubHandler

public SolrRequestHandler getSubHandler(String path)

Description copied from interface: NestedRequestHandler

Return a RequestHandler to handle a subpath from the path this handler is registered.

Specified by:

getSubHandler in interface NestedRequestHandler

Overrides:

getSubHandler in class RequestHandlerBase

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

getActiveReplicas

public static List<org.apache.solr.common.cloud.Replica> getActiveReplicas(ZkController zkController,
 String collection)

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

Specified by:

getPermissionName in interface PermissionNameProvider

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()

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