org.apache.solr.client.solrj.impl

Class CloudSolrClient.Builder

java.lang.Object

org.apache.solr.client.solrj.impl.SolrClientBuilder<CloudSolrClient.Builder>

org.apache.solr.client.solrj.impl.CloudSolrClient.Builder

Enclosing class:

CloudSolrClient

public static class CloudSolrClient.Builder
extends SolrClientBuilder<CloudSolrClient.Builder>

Constructs CloudSolrClient instances from provided configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	directUpdatesToLeadersOnly
protected LBHttpSolrClient.Builder	lbClientBuilder
protected LBHttpSolrClient	loadBalancedSolrClient
protected boolean	parallelUpdates
protected boolean	shardLeadersOnly
protected List<String>	solrUrls
protected ClusterStateProvider	stateProvider
protected String	zkChroot
protected Collection<String>	zkHosts

Fields inherited from class org.apache.solr.client.solrj.impl.SolrClientBuilder

connectionTimeoutMillis, httpClient, responseParser, socketTimeoutMillis

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CloudSolrClient	build() Create a CloudSolrClient based on the provided configuration.
CloudSolrClient.Builder	getThis() The solution for the unchecked cast warning.
CloudSolrClient.Builder	sendDirectUpdatesToAnyShardReplica() Tells CloudSolrClient.Builder that created clients can send updates to any shard replica (shard leaders and non-leaders).
CloudSolrClient.Builder	sendDirectUpdatesToShardLeadersOnly() Tells CloudSolrClient.Builder that created clients should send direct updates to shard leaders only.
CloudSolrClient.Builder	sendUpdatesOnlyToShardLeaders() Tells CloudSolrClient.Builder that created clients should send updates only to shard leaders.
CloudSolrClient.Builder	sendUpdatesToAllReplicasInShard() Tells CloudSolrClient.Builder that created clients should send updates to all replicas for a shard.
CloudSolrClient.Builder	withClusterStateProvider(ClusterStateProvider stateProvider)
CloudSolrClient.Builder	withLBHttpSolrClient(LBHttpSolrClient loadBalancedSolrClient) Provides a LBHttpSolrClient for the builder to use when creating clients.
CloudSolrClient.Builder	withLBHttpSolrClientBuilder(LBHttpSolrClient.Builder lbHttpSolrClientBuilder) Provides a HttpClient for the builder to use when creating clients.
CloudSolrClient.Builder	withParallelUpdates(boolean parallelUpdates) Should direct updates to shards be done in parallel (the default) or if not then synchronously?
CloudSolrClient.Builder	withSolrUrl(Collection<String> solrUrls) Provide a list of Solr URL to be used when configuring CloudSolrClient instances.
CloudSolrClient.Builder	withSolrUrl(String solrUrl) Provide a Solr URL to be used when configuring CloudSolrClient instances.
CloudSolrClient.Builder	withZkChroot(String zkChroot) Provides a ZooKeeper chroot for the builder to use when creating clients.
CloudSolrClient.Builder	withZkHost(Collection<String> zkHosts) Provide a series of ZooKeeper client endpoints for the builder to use when creating clients.
CloudSolrClient.Builder	withZkHost(String zkHost) Provide a ZooKeeper client endpoint to be used when configuring CloudSolrClient instances.

Methods inherited from class org.apache.solr.client.solrj.impl.SolrClientBuilder

withConnectionTimeout, withHttpClient, withResponseParser, withSocketTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

zkHosts

protected Collection<String> zkHosts

solrUrls

protected List<String> solrUrls

zkChroot

protected String zkChroot

loadBalancedSolrClient

protected LBHttpSolrClient loadBalancedSolrClient

lbClientBuilder

protected LBHttpSolrClient.Builder lbClientBuilder

shardLeadersOnly

protected boolean shardLeadersOnly

directUpdatesToLeadersOnly

protected boolean directUpdatesToLeadersOnly

parallelUpdates

protected boolean parallelUpdates

stateProvider

protected ClusterStateProvider stateProvider

Constructor Detail

Builder

public Builder()

Method Detail

withZkHost

public CloudSolrClient.Builder withZkHost(String zkHost)

Provide a ZooKeeper client endpoint to be used when configuring CloudSolrClient instances. Method may be called multiple times. All provided values will be used.

Parameters:

zkHost - The client endpoint of the ZooKeeper quorum containing the cloud state.

withSolrUrl

public CloudSolrClient.Builder withSolrUrl(String solrUrl)

Provide a Solr URL to be used when configuring CloudSolrClient instances. Method may be called multiple times. One of the provided values will be used to fetch the list of live Solr nodes that the underlying HttpClusterStateProvider would be maintaining. Provided Solr URL is expected to point to the root Solr path ("http://hostname:8983/solr"); it should not include any collections, cores, or other path components.

withSolrUrl

public CloudSolrClient.Builder withSolrUrl(Collection<String> solrUrls)

Provide a list of Solr URL to be used when configuring CloudSolrClient instances. One of the provided values will be used to fetch the list of live Solr nodes that the underlying HttpClusterStateProvider would be maintaining. Provided Solr URLs are expected to point to the root Solr path ("http://hostname:8983/solr"); they should not include any collections, cores, or other path components.

withLBHttpSolrClientBuilder

public CloudSolrClient.Builder withLBHttpSolrClientBuilder(LBHttpSolrClient.Builder lbHttpSolrClientBuilder)

Provides a HttpClient for the builder to use when creating clients.

withZkHost

public CloudSolrClient.Builder withZkHost(Collection<String> zkHosts)

Provide a series of ZooKeeper client endpoints for the builder to use when creating clients. Method may be called multiple times. All provided values will be used.

Parameters:

zkHosts - A Java Collection (List, Set, etc) of HOST:PORT strings, one for each host in the ZooKeeper ensemble. Note that with certain Collection types like HashSet, the order of hosts in the final connect string may not be in the same order you added them.

withZkChroot

public CloudSolrClient.Builder withZkChroot(String zkChroot)

Provides a ZooKeeper chroot for the builder to use when creating clients.

withLBHttpSolrClient

public CloudSolrClient.Builder withLBHttpSolrClient(LBHttpSolrClient loadBalancedSolrClient)

Provides a LBHttpSolrClient for the builder to use when creating clients.

sendUpdatesOnlyToShardLeaders

public CloudSolrClient.Builder sendUpdatesOnlyToShardLeaders()

Tells CloudSolrClient.Builder that created clients should send updates only to shard leaders.

sendUpdatesToAllReplicasInShard

public CloudSolrClient.Builder sendUpdatesToAllReplicasInShard()

Tells CloudSolrClient.Builder that created clients should send updates to all replicas for a shard.

sendDirectUpdatesToShardLeadersOnly

public CloudSolrClient.Builder sendDirectUpdatesToShardLeadersOnly()

Tells CloudSolrClient.Builder that created clients should send direct updates to shard leaders only.

sendDirectUpdatesToAnyShardReplica

public CloudSolrClient.Builder sendDirectUpdatesToAnyShardReplica()

Tells CloudSolrClient.Builder that created clients can send updates to any shard replica (shard leaders and non-leaders).

withParallelUpdates

public CloudSolrClient.Builder withParallelUpdates(boolean parallelUpdates)

Should direct updates to shards be done in parallel (the default) or if not then synchronously?

withClusterStateProvider

public CloudSolrClient.Builder withClusterStateProvider(ClusterStateProvider stateProvider)

build

public CloudSolrClient build()

Create a CloudSolrClient based on the provided configuration.

getThis

public CloudSolrClient.Builder getThis()

Description copied from class: SolrClientBuilder

The solution for the unchecked cast warning.

Specified by:

getThis in class SolrClientBuilder<CloudSolrClient.Builder>