Package org.apache.solr.handler.component

Class SearchHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.component.SearchHandler

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider, PluginInfoInitialized, SolrCoreAware

Direct Known Subclasses:

ExportHandler, RealTimeGetHandler, StandardRequestHandler

public class SearchHandler
extends RequestHandlerBase
implements SolrCoreAware, PluginInfoInitialized, PermissionNameProvider

Refer SOLR-281

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.handler.RequestHandlerBase

RequestHandlerBase.HandlerMetrics

Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider

PermissionNameProvider.Name

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
protected List<SearchComponent>	components
static final io.opentelemetry.api.common.AttributeKey<Boolean>	INTERNAL_ATTR

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

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

TYPE

Constructor Summary

Constructors

Constructor	Description
SearchHandler()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkCircuitBreakers(SolrQueryRequest req, SolrQueryResponse rsp, ResponseBuilder rb)	Check if SolrRequest.SolrRequestType.QUERY circuit breakers are tripped.
ShardHandler	getAndPrepShardHandler(SolrQueryRequest req, ResponseBuilder rb)
List<SearchComponent>	getComponents()
protected List<String>	getDefaultComponents()
String	getDescription()	Simple one or two line description
RequestHandlerBase.HandlerMetrics	getMetricsForThisRequest(SolrQueryRequest req)	The metrics to be used for this request.
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)
void	initializeMetrics(SolrMetricsContext parentContext, io.opentelemetry.api.common.Attributes attributes)	Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component
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
protected String	stageToString(int stage)

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getApis, getCategory, getInitArgs, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, isInternalShardRequest, processErrorMetricsOnException, processReceivedException, setPluginInfo

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.api.ApiSupport

getJerseyResources, registerV1

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close

Field Details

INTERNAL_ATTR

public static final io.opentelemetry.api.common.AttributeKey<Boolean> INTERNAL_ATTR

components

protected volatile List<SearchComponent> components

Constructor Details

SearchHandler

public SearchHandler()

Method Details

getDefaultComponents

protected List<String> getDefaultComponents()

init

public void init(PluginInfo info)

Specified by:

init in interface PluginInfoInitialized

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
 io.opentelemetry.api.common.Attributes attributes)

Description copied from interface: SolrMetricProducer

Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component

Specified by:

initializeMetrics in interface SolrMetricProducer

Overrides:

initializeMetrics in class RequestHandlerBase

Parameters:

parentContext - The registry that the component will initialize metrics to

attributes - Base set of attributes that will be bound to all metrics for that component

getMetricsForThisRequest

public RequestHandlerBase.HandlerMetrics getMetricsForThisRequest(SolrQueryRequest req)

Description copied from class: RequestHandlerBase

The metrics to be used for this request.

Overrides:

getMetricsForThisRequest in class RequestHandlerBase

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

Specified by:

getPermissionName in interface PermissionNameProvider

inform

public void inform(SolrCore core)

Initialize the components based on name. Note, if using 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.

Specified by:

inform in interface SolrCoreAware

getComponents

public List<SearchComponent> getComponents()

getAndPrepShardHandler

public ShardHandler getAndPrepShardHandler(SolrQueryRequest req,
 ResponseBuilder rb)

newResponseBuilder

protected ResponseBuilder newResponseBuilder(SolrQueryRequest req,
 SolrQueryResponse rsp,
 List<SearchComponent> components)

Override this method if you require a custom ResponseBuilder e.g. for use by a custom SearchComponent.

checkCircuitBreakers

protected boolean checkCircuitBreakers(SolrQueryRequest req,
 SolrQueryResponse rsp,
 ResponseBuilder rb)

Check if SolrRequest.SolrRequestType.QUERY circuit breakers are tripped. Override this method in sub classes that do not want to check circuit breakers.

Returns:

true if circuit breakers are tripped, false otherwise.

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

stageToString

protected String stageToString(int stage)

getOrGenerateRequestId

public static String getOrGenerateRequestId(SolrQueryRequest req)

Returns a String to use as an identifier for this request.

If the provided 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.

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class RequestHandlerBase

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

Whether this request handler must be made available at the /v2/ path

Specified by:

registerV2 in interface ApiSupport