Package org.apache.solr.request

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, UpdateRequestHandlerApi, 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.

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	Description
static String	TYPE

Method Summary

Modifier and Type	Method	Description
void	handleRequest(SolrQueryRequest req, SolrQueryResponse rsp)	Handles a query request, this method must be thread safe.
void	init(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(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.