org.apache.solr.handler.component

Class HttpShardHandlerFactory

java.lang.Object

org.apache.solr.handler.component.ShardHandlerFactory

org.apache.solr.handler.component.HttpShardHandlerFactory

All Implemented Interfaces:

AutoCloseable, SolrMetricProducer, PluginInfoInitialized

public class HttpShardHandlerFactory
extends ShardHandlerFactory
implements PluginInfoInitialized, SolrMetricProducer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpShardHandlerFactory.WhitelistHostChecker Class used to validate the hosts in the "shards" parameter when doing a distributed request

Field Summary

Fields

Modifier and Type	Field and Description
protected Http2SolrClient	defaultClient
protected InstrumentedHttpListenerFactory	httpListenerFactory
static String	INIT_SHARDS_WHITELIST
protected Random	r

Fields inherited from class org.apache.solr.handler.component.ShardHandlerFactory

DEFAULT_SHARDHANDLER_INFO

Constructor Summary

Constructors

Constructor and Description
HttpShardHandlerFactory()

Method Summary

Modifier and Type	Method and Description
List<String>	buildURLList(String shard) Creates a list of urls for the given shard.
void	close() Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered.
protected <T> T	getParameter(NamedList initArgs, String configKey, T defaultValue, StringBuilder sb)
protected ReplicaListTransformer	getReplicaListTransformer(SolrQueryRequest req)
ShardHandler	getShardHandler() Get ShardHandler that uses the default http client.
ShardHandler	getShardHandler(Http2SolrClient httpClient) Get ShardHandler that uses custom http client.
ShardHandler	getShardHandler(org.apache.http.client.HttpClient httpClient) Deprecated.
HttpShardHandlerFactory.WhitelistHostChecker	getWhitelistHostChecker() Returns this Factory's HttpShardHandlerFactory.WhitelistHostChecker.
void	init(PluginInfo info)
void	initializeMetrics(SolrMetricManager manager, String registry, String tag, String scope) Initializes metrics specific to this producer
LBSolrClient.Rsp	makeLoadBalancedRequest(QueryRequest req, List<String> urls) Makes a request to one or more of the given urls, using the configured load balancer.
CompletionService<ShardResponse>	newCompletionService() Creates a new completion service for use by a single set of distributed requests.
protected LBSolrClient.Req	newLBHttpSolrClientReq(QueryRequest req, List<String> urls)
void	setSecurityBuilder(HttpClientBuilderPlugin clientBuilderPlugin)

Methods inherited from class org.apache.solr.handler.component.ShardHandlerFactory

newInstance

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.metrics.SolrMetricProducer

getSolrMetricsContext, getUniqueMetricTag, initializeMetrics

Field Detail

defaultClient

protected volatile Http2SolrClient defaultClient

httpListenerFactory

protected InstrumentedHttpListenerFactory httpListenerFactory

r

protected final Random r

INIT_SHARDS_WHITELIST

public static final String INIT_SHARDS_WHITELIST

See Also:

Constant Field Values

Constructor Detail

HttpShardHandlerFactory

public HttpShardHandlerFactory()

Method Detail

getShardHandler

public ShardHandler getShardHandler()

Get ShardHandler that uses the default http client.

Specified by:

getShardHandler in class ShardHandlerFactory

getShardHandler

public ShardHandler getShardHandler(Http2SolrClient httpClient)

Get ShardHandler that uses custom http client.

getShardHandler

@Deprecated
public ShardHandler getShardHandler(org.apache.http.client.HttpClient httpClient)

Deprecated.

getWhitelistHostChecker

public HttpShardHandlerFactory.WhitelistHostChecker getWhitelistHostChecker()

Returns this Factory's HttpShardHandlerFactory.WhitelistHostChecker. This method can be overridden to change the checker implementation.

init

public void init(PluginInfo info)

Specified by:

init in interface PluginInfoInitialized

setSecurityBuilder

public void setSecurityBuilder(HttpClientBuilderPlugin clientBuilderPlugin)

Overrides:

setSecurityBuilder in class ShardHandlerFactory

getParameter

protected <T> T getParameter(NamedList initArgs,
                             String configKey,
                             T defaultValue,
                             StringBuilder sb)

close

public void close()

Description copied from interface: SolrMetricProducer

Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered. This prevents obscure memory leaks.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SolrMetricProducer

Specified by:

close in class ShardHandlerFactory

makeLoadBalancedRequest

public LBSolrClient.Rsp makeLoadBalancedRequest(QueryRequest req,
                                                List<String> urls)
                                         throws SolrServerException,
                                                IOException

Makes a request to one or more of the given urls, using the configured load balancer.

Parameters:

req - The solr search request that should be sent through the load balancer

urls - The list of solr server urls to load balance across

Returns:

The response from the request

Throws:

SolrServerException

IOException

newLBHttpSolrClientReq

protected LBSolrClient.Req newLBHttpSolrClientReq(QueryRequest req,
                                                  List<String> urls)

buildURLList

public List<String> buildURLList(String shard)

Creates a list of urls for the given shard.

Parameters:

shard - the urls for the shard, separated by '|'

Returns:

A list of valid urls (including protocol) that are replicas for the shard

getReplicaListTransformer

protected ReplicaListTransformer getReplicaListTransformer(SolrQueryRequest req)

newCompletionService

public CompletionService<ShardResponse> newCompletionService()

Creates a new completion service for use by a single set of distributed requests.

initializeMetrics

public void initializeMetrics(SolrMetricManager manager,
                              String registry,
                              String tag,
                              String scope)

Description copied from interface: SolrMetricProducer

Initializes metrics specific to this producer

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

manager - an instance of SolrMetricManager

registry - registry name where metrics are registered

tag - a symbolic tag that represents this instance of the producer, or a group of related instances that have the same life-cycle. This tag is used when managing life-cycle of some metrics.

scope - scope of the metrics (eg. handler name) to separate metrics of components with the same implementation but different scope.