Package com.norconex.committer.solr

Class SolrCommitter

java.lang.Object

com.norconex.committer.core.AbstractCommitter<SolrCommitterConfig>

com.norconex.committer.core.batch.AbstractBatchCommitter<SolrCommitterConfig>

com.norconex.committer.solr.SolrCommitter

All Implemented Interfaces:

BatchConsumer, Committer, Configurable<SolrCommitterConfig>, AutoCloseable

public class SolrCommitter
extends AbstractBatchCommitter<SolrCommitterConfig>

Commits documents to Apache Solr.

Solr Client:

You can specify which type of Solr Client to use. The expected configuration value of "solrURL" is influenced by the client type chosen. Default client type is Http2SolrClient. The clients are:

Http2SolrClient

Default client. For direct access to a single Solr node. Ideal for local development or small setups. Expects a Solr URL.

CloudSolrClient

For use with a SolrCloud cluster. Expects a comma-separated list of Zookeeper hosts.

LBHttp2SolrClient

Simple load-balancing as an alternative to an external load balancer. Expects two or more Solr node URLs (comma-separated).

ConcurrentUpdateHttp2SolrClient

Optimized for mass upload on a single node. Not best for queries. Expects a Solr URL.

The above client types are using the HTTP/2 protocol. They should be favored over the following, which are using HTTP/1.x and are considered deprecated:

HttpSolrClient

For direct access to a single Solr node. Ideal for local development. Expects a Solr URL.

LBHttpSolrClient

Simple load-balancing as an alternative to an external load balancer. Expects two or more Solr node URLs (comma-separated).

ConcurrentUpdateSolrClient

Optimized for mass upload on a single node. Not best for queries. Expects a Solr URL.

Authentication

Basic authentication is supported for password-protected Solr installations.

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
SolrCommitter()

Method Summary

Modifier and Type	Method	Description
protected void	addSolrDeleteRequest(org.apache.solr.client.solrj.request.UpdateRequest solrBatchRequest, DeleteRequest committerRequest)
protected void	addSolrUpsertRequest(org.apache.solr.client.solrj.request.UpdateRequest solrBatchRequest, UpsertRequest committerRequest)
protected org.apache.solr.common.SolrInputDocument	buildSolrDocument(Properties fields)
protected boolean	canEqual(Object other)
protected void	closeBatchCommitter()	Subclasses can perform additional closing logic by overriding this method.
protected void	commitBatch(Iterator<CommitterRequest> it)	Commits the supplied batch.
boolean	equals(Object o)
SolrCommitterConfig	getConfiguration()
int	hashCode()
protected void	initBatchCommitter()	Subclasses can perform additional initialization by overriding this method.
protected void	pushSolrRequest(org.apache.solr.client.solrj.request.UpdateRequest solrBatchRequest)
String	toString()

Methods inherited from class com.norconex.committer.core.batch.AbstractBatchCommitter

consume, doClean, doClose, doDelete, doInit, doUpsert, getInitializedQueue

Methods inherited from class com.norconex.committer.core.AbstractCommitter

accept, applyFieldMappings, clean, close, delete, fireDebug, fireDebug, fireError, fireError, fireInfo, fireInfo, getCommitterContext, init, upsert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SolrCommitter

public SolrCommitter()

Method Details

initBatchCommitter

protected void initBatchCommitter()
                           throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional initialization by overriding this method. Default implementation does nothing. The committer context and committer queue will be already initialized when invoking AbstractCommitter.getCommitterContext() and AbstractBatchCommitter.getInitializedQueue(), respectively.

Overrides:

initBatchCommitter in class AbstractBatchCommitter<SolrCommitterConfig>

Throws:

CommitterException - error initializing

commitBatch

protected void commitBatch(Iterator<CommitterRequest> it)
                    throws CommitterException

Description copied from class: AbstractBatchCommitter

Commits the supplied batch.

Specified by:

commitBatch in class AbstractBatchCommitter<SolrCommitterConfig>

Parameters:

it - the batch to commit

Throws:

CommitterException - could not commit the batch

closeBatchCommitter

protected void closeBatchCommitter()
                            throws CommitterException

Description copied from class: AbstractBatchCommitter

Subclasses can perform additional closing logic by overriding this method. Default implementation does nothing.

Overrides:

closeBatchCommitter in class AbstractBatchCommitter<SolrCommitterConfig>

Throws:

CommitterException - error closing committer

pushSolrRequest

protected void pushSolrRequest(org.apache.solr.client.solrj.request.UpdateRequest solrBatchRequest)
                        throws org.apache.solr.client.solrj.SolrServerException,
IOException,
CommitterException

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

CommitterException

addSolrUpsertRequest

protected void addSolrUpsertRequest(org.apache.solr.client.solrj.request.UpdateRequest solrBatchRequest,
 UpsertRequest committerRequest)
                             throws CommitterException

Throws:

CommitterException

addSolrDeleteRequest

protected void addSolrDeleteRequest(org.apache.solr.client.solrj.request.UpdateRequest solrBatchRequest,
 DeleteRequest committerRequest)

buildSolrDocument

protected org.apache.solr.common.SolrInputDocument buildSolrDocument(Properties fields)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractBatchCommitter<SolrCommitterConfig>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractBatchCommitter<SolrCommitterConfig>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBatchCommitter<SolrCommitterConfig>

toString

public String toString()

Overrides:

toString in class AbstractBatchCommitter<SolrCommitterConfig>

getConfiguration

public SolrCommitterConfig getConfiguration()