public class SearchHandler extends RequestHandlerBase implements SolrCoreAware, PluginInfoInitialized, PermissionNameProvider
PermissionNameProvider.Name
SolrInfoBean.Category, SolrInfoBean.Group
Modifier and Type | Field and Description |
---|---|
protected List<SearchComponent> |
components |
appends, defaults, httpCaching, initArgs, invariants, solrMetricsContext
ANY, NULL, values
TYPE
Constructor and Description |
---|
SearchHandler() |
Modifier and Type | Method and Description |
---|---|
List<SearchComponent> |
getComponents() |
protected List<String> |
getDefaultComponents() |
String |
getDescription()
Simple one or two line description
|
static String |
getOrGenerateRequestId(SolrQueryRequest req)
Returns a String to use as an identifier for this request.
|
PermissionNameProvider.Name |
getPermissionName(AuthorizationContext ctx) |
void |
handleRequestBody(SolrQueryRequest req,
SolrQueryResponse rsp) |
void |
inform(SolrCore core)
Initialize the components based on name.
|
void |
init(PluginInfo info) |
protected ResponseBuilder |
newResponseBuilder(SolrQueryRequest req,
SolrQueryResponse rsp,
List<SearchComponent> components)
Override this method if you require a custom
ResponseBuilder e.g. |
Boolean |
registerV2()
Whether this request handler must be made available at the /v2/ path
|
getApis, getCategory, getInitArgs, getMetricNames, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, initializeMetrics, setPluginInfo
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMetricRegistry, getMetricsSnapshot, registerMetricName
close, getUniqueMetricTag, initializeMetrics
registerV1
protected volatile List<SearchComponent> components
public void init(PluginInfo info)
init
in interface PluginInfoInitialized
public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)
getPermissionName
in interface PermissionNameProvider
public void inform(SolrCore core)
INIT_FIRST_COMPONENTS
or INIT_LAST_COMPONENTS
,
then the DebugComponent
will always occur last. If this is not desired, then one must explicitly declare all components using
the INIT_COMPONENTS
syntax.inform
in interface SolrCoreAware
public List<SearchComponent> getComponents()
protected ResponseBuilder newResponseBuilder(SolrQueryRequest req, SolrQueryResponse rsp, List<SearchComponent> components)
ResponseBuilder
e.g. for use by a custom SearchComponent
.public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception
handleRequestBody
in class RequestHandlerBase
Exception
public static String getOrGenerateRequestId(SolrQueryRequest req)
SolrQueryRequest
contains a non-blank CommonParams.REQUEST_ID
param value this is
used. This is especially useful for users who deploy Solr as one component in a larger ecosystem, and want to use
an external ID utilized by other components as well. If no CommonParams.REQUEST_ID
value is present, one
is generated from scratch for the request.
Callers are responsible for storing the returned value in the SolrQueryRequest
object if they want to
ensure that ID generation is not redone on subsequent calls.
public String getDescription()
SolrInfoBean
getDescription
in interface SolrInfoBean
getDescription
in class RequestHandlerBase
public Boolean registerV2()
ApiSupport
registerV2
in interface ApiSupport
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.