org.apache.solr.handler

Class RequestHandlerBase

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler

Direct Known Subclasses:

AnalysisRequestHandlerBase, AutoScalingHandler, AutoscalingHistoryHandler, BlobHandler, CdcrRequestHandler, CollectionsHandler, ConfigSetsHandler, ContentStreamHandlerBase, CoreAdminHandler, DumpRequestHandler, FileFloatSource.ReloadCacheRequestHandler, GraphHandler, HealthCheckHandler, InfoHandler, LoggingHandler, LukeRequestHandler, MetricsCollectorHandler, MetricsHandler, MetricsHistoryHandler, MoreLikeThisHandler, NotFoundRequestHandler, PingRequestHandler, PluginInfoHandler, PropertiesRequestHandler, PublicKeyHandler, ReplicationHandler, SchemaHandler, SearchHandler, SecurityConfHandler, SegmentsInfoRequestHandler, ShowFileRequestHandler, SolrConfigHandler, SolrInfoMBeanHandler, SQLHandler, StreamHandler, SystemInfoHandler, TaggerRequestHandler, ThreadDumpHandler, ZookeeperInfoHandler, ZookeeperStatusHandler

public abstract class RequestHandlerBase
extends Object
implements SolrRequestHandler, SolrInfoBean, SolrMetricProducer, NestedRequestHandler, ApiSupport

Nested Class Summary

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 SolrParams	appends
protected SolrParams	defaults
protected boolean	httpCaching
protected NamedList	initArgs
protected SolrParams	invariants
protected SolrMetricsContext	solrMetricsContext

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

TYPE

Constructor Summary

Constructors

Constructor and Description
RequestHandlerBase()

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
abstract String	getDescription() Simple one or two line description
NamedList	getInitArgs()
Set<String>	getMetricNames() Modifiable set of metric names that this component reports (default is null, which means none).
String	getName() Simple common usage name, e.g.
PluginInfo	getPluginInfo()
static SolrRequestHandler	getRequestHandler(String handlerName, PluginBag<SolrRequestHandler> reqHandlers) Get the request handler registered to a given name.
SolrMetricsContext	getSolrMetricsContext() Implementing classes should override this method to provide the context obtained in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
static SolrParams	getSolrParamsFromNamedList(NamedList args, String key)
SolrRequestHandler	getSubHandler(String subPath) Return a RequestHandler to handle a subpath from the path this handler is registered.
void	handleRequest(SolrQueryRequest req, SolrQueryResponse rsp) Handles a query request, this method must be thread safe.
abstract void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
void	init(NamedList args) Initializes the SolrRequestHandler by creating three SolrParams named.
void	initializeMetrics(SolrMetricsContext parentContext, String scope) Initialize metrics specific to this producer.
void	setPluginInfo(PluginInfo pluginInfo)

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, registerV2

Field Detail

initArgs

protected NamedList initArgs

defaults

protected SolrParams defaults

appends

protected SolrParams appends

invariants

protected SolrParams invariants

httpCaching

protected boolean httpCaching

solrMetricsContext

protected SolrMetricsContext solrMetricsContext

Constructor Detail

RequestHandlerBase

public RequestHandlerBase()

Method Detail

init

public void init(NamedList args)

Initializes the SolrRequestHandler by creating three SolrParams named.

Name	Description
defaults	Contains all of the named arguments contained within the list element named "defaults".
appends	Contains all of the named arguments contained within the list element named "appends".
invariants	Contains all of the named arguments contained within the list element named "invariants".

Example:

 <lst name="defaults">
 <str name="echoParams">explicit</str>
 <str name="qf">text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0</str>
 <str name="mm">2<-1 5<-2 6<90%</str>
 <str name="bq">incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2</str>
 </lst>
 <lst name="appends">
 <str name="fq">inStock:true</str>
 </lst>

 <lst name="invariants">
 <str name="facet.field">cat</str>
 <str name="facet.field">manu_exact</str>
 <str name="facet.query">price:[* TO 500]</str>
 <str name="facet.query">price:[500 TO *]</str>
 </lst>
 

Specified by:

init in interface SolrRequestHandler

Parameters:

args - The NamedList to initialize from

See Also:

handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse), handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse), SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams),

See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Description copied from interface: SolrMetricProducer

Implementing classes should override this method to provide the context obtained in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.

Specified by:

getSolrMetricsContext in interface SolrMetricProducer

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
                              String scope)

Description copied from interface: SolrMetricProducer

Initialize metrics specific to this producer.

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - parent metrics context. If this component has the same life-cycle as the parent it can simply use the parent context, otherwise it should obtain a child context using SolrMetricsContext.getChildContext(Object) passing this as the child.

scope - component scope

getSolrParamsFromNamedList

public static SolrParams getSolrParamsFromNamedList(NamedList args,
                                                    String key)

getInitArgs

public NamedList getInitArgs()

handleRequestBody

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

Throws:

Exception

handleRequest

public void handleRequest(SolrQueryRequest req,
                          SolrQueryResponse rsp)

Description copied from interface: SolrRequestHandler

Handles a query request, this method must be thread safe.

Information about the request may be obtained from req and response information may be set using rsp.

There are no mandatory actions that handleRequest must perform. An empty handleRequest implementation would fulfill all interface obligations.

Specified by:

handleRequest in interface SolrRequestHandler

getName

public String getName()

Description copied from interface: SolrInfoBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

Specified by:

getName in interface SolrInfoBean

getDescription

public abstract String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

getMetricNames

public Set<String> getMetricNames()

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean

getSubHandler

public SolrRequestHandler getSubHandler(String subPath)

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

getRequestHandler

public static SolrRequestHandler getRequestHandler(String handlerName,
                                                   PluginBag<SolrRequestHandler> reqHandlers)

Get the request handler registered to a given name.

This function is thread safe.

setPluginInfo

public void setPluginInfo(PluginInfo pluginInfo)

getPluginInfo

public PluginInfo getPluginInfo()

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

Returns:

the list of v2 api implementations