Package org.apache.solr.request

Interface SolrRequestHandler

All Superinterfaces:
AutoCloseable, SolrInfoBean, SolrMetricProducer
All Known Implementing Classes:
ActiveTasksListHandler, AnalysisRequestHandlerBase, CollectionsHandler, ConfigSetsHandler, ContentStreamHandlerBase, CoreAdminHandler, DocumentAnalysisRequestHandler, DumpRequestHandler, ExportHandler, FieldAnalysisRequestHandler, GraphHandler, HealthCheckHandler, InfoHandler, LoggingHandler, LukeRequestHandler, MetricsHandler, MoreLikeThisHandler, NotFoundRequestHandler, PingRequestHandler, PropertiesRequestHandler, PublicKeyHandler, QueryCancellationHandler, RealTimeGetHandler, ReplicationHandler, RequestHandlerBase, SchemaHandler, SearchHandler, SecurityConfHandler, SecurityConfHandlerLocal, SecurityConfHandlerZk, SegmentsInfoRequestHandler, ShowFileRequestHandler, SolrConfigHandler, StandardRequestHandler, StreamHandler, SystemInfoHandler, TaggerRequestHandler, TaskManagementHandler, ThreadDumpHandler, UpdateRequestHandler, V2UpdateRequestHandler, ZookeeperInfoHandler, ZookeeperStatusHandler
public interface SolrRequestHandler extends SolrInfoBean
Implementations of SolrRequestHandler are called to handle query requests.

Different SolrRequestHandlers are registered with the SolrCore. One way to register a SolrRequestHandler with the core is through the solrconfig.xml file.

Example solrconfig.xml entry to register a SolrRequestHandler 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.

  • Field Details

  • Method Details

    • 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 using rsp.

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