Interface SolrRequestHandler
-
- All Superinterfaces:
AutoCloseable
,SolrInfoBean
,SolrMetricProducer
- All Known Implementing Classes:
ActiveTasksListHandler
,AnalysisRequestHandlerBase
,BlobHandler
,CollectionsHandler
,ConfigSetsHandler
,ContentStreamHandlerBase
,CoreAdminHandler
,DocumentAnalysisRequestHandler
,DumpRequestHandler
,ExportHandler
,FieldAnalysisRequestHandler
,FileFloatSource.ReloadCacheRequestHandler
,GraphHandler
,HealthCheckHandler
,InfoHandler
,LoggingHandler
,LukeRequestHandler
,MetricsCollectorHandler
,MetricsHandler
,MoreLikeThisHandler
,NotFoundRequestHandler
,PingRequestHandler
,PluginInfoHandler
,PropertiesRequestHandler
,PublicKeyHandler
,QueryCancellationHandler
,RealTimeGetHandler
,ReplicationHandler
,RequestHandlerBase
,SchemaHandler
,SearchHandler
,SecurityConfHandler
,SecurityConfHandlerLocal
,SecurityConfHandlerZk
,SegmentsInfoRequestHandler
,ShowFileRequestHandler
,SolrConfigHandler
,SolrInfoMBeanHandler
,StandardRequestHandler
,StreamHandler
,SystemInfoHandler
,TaggerRequestHandler
,TaskManagementHandler
,ThreadDumpHandler
,UpdateRequestHandler
,V2UpdateRequestHandler
,ZookeeperInfoHandler
,ZookeeperStatusHandler
public interface SolrRequestHandler extends SolrInfoBean
Implementations ofSolrRequestHandler
are called to handle query requests.Different
SolrRequestHandler
s are registered with theSolrCore
. One way to register a SolrRequestHandler with the core is through thesolrconfig.xml
file.Example
solrconfig.xml
entry to register aSolrRequestHandler
implementation to handle all queries with a Request Handler of "/test":<requestHandler name="/test" class="solr.tst.TestRequestHandler" />
A single instance of any registered SolrRequestHandler is created via the default constructor and is reused for all relevant queries.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
SolrInfoBean.Category, SolrInfoBean.Group
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
handleRequest(SolrQueryRequest req, SolrQueryResponse rsp)
Handles a query request, this method must be thread safe.void
init(org.apache.solr.common.util.NamedList<?> args)
init
will be called just once, immediately after creation.-
Methods inherited from interface org.apache.solr.core.SolrInfoBean
getCategory, getDescription, getName
-
Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer
close, getSolrMetricsContext, initializeMetrics
-
-
-
-
Field Detail
-
TYPE
static final String TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
init
void init(org.apache.solr.common.util.NamedList<?> args)
init
will be called just once, immediately after creation.The args are user-level initialization parameters that may be specified when declaring a request handler in solrconfig.xml
-
handleRequest
void handleRequest(SolrQueryRequest req, SolrQueryResponse rsp)
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 usingrsp
.There are no mandatory actions that handleRequest must perform. An empty handleRequest implementation would fulfill all interface obligations.
-
-