Package com.norconex.committer.solr

Class SolrCommitterConfig

java.lang.Object
com.norconex.committer.core.BaseCommitterConfig
com.norconex.committer.core.batch.BaseBatchCommitterConfig
com.norconex.committer.solr.SolrCommitterConfig
public class SolrCommitterConfig extends BaseBatchCommitterConfig

Configuration for SolrCommitter.

  • Field Details

    • DEFAULT_SOLR_ID_FIELD

      public static final String DEFAULT_SOLR_ID_FIELD
      Default Solr ID field
      See Also:

    • DEFAULT_SOLR_CONTENT_FIELD

      public static final String DEFAULT_SOLR_CONTENT_FIELD
      Default Solr content field
      See Also:

  • Constructor Details

    • SolrCommitterConfig

      public SolrCommitterConfig()

  • Method Details

    • getUpdateUrlParams

      public Map<String,String> getUpdateUrlParams()
      Gets URL parameters to be added on Solr HTTP calls.
      Returns:
      a map of parameter names and values

    • setUpdateUrlParams

      public void setUpdateUrlParams(Map<String,String> updateUrlParams)
      Sets URL parameters to be added on Solr HTTP calls.
      Parameters:
      updateUrlParams - a map of parameter names and values

    • setUpdateUrlParam

      public void setUpdateUrlParam(String name, String value)
      Sets a URL parameter to be added on Solr HTTP calls.
      Parameters:
      name - parameter name
      value - parameter value

    • getUpdateUrlParam

      public String getUpdateUrlParam(String name)
      Gets a URL parameter value by its parameter name.
      Parameters:
      name - parameter name
      Returns:
      parameter value

    • getUpdateUrlParamNames

      public Set<String> getUpdateUrlParamNames()
      Gets the update URL parameter names.
      Returns:
      parameter names

    • getCredentials

      public Credentials getCredentials()
      Gets Solr authentication credentials.
      Returns:
      credentials

    • setCredentials

      public void setCredentials(Credentials credentials)
      Sets Solr authentication credentials.
      Parameters:
      credentials - the credentials

    • getSolrClientType

      public SolrClientType getSolrClientType()
      The type of Solr client.

    • getSolrURL

      public String getSolrURL()
      The endpoint URL used to connect to Solr (as per the client type selected).

    • isSolrCommitDisabled

      public boolean isSolrCommitDisabled()
      Whether to send an explicit commit request at the end of every batch, or let the server auto-commit.

    • getSourceIdField

      public String getSourceIdField()
      The document field name containing the value to be stored in Solr ID field. A null value (default) will use the document reference instead of a document field.

    • getTargetIdField

      public String getTargetIdField()
      The name of the Solr field where to store a document unique identifier (sourceIdField). Default is "id".

    • getTargetContentField

      public String getTargetContentField()
      The name of the Solr field where content will be stored. Default is "content". A null value will disable storing the content.

    • setSolrClientType

      public SolrCommitterConfig setSolrClientType(SolrClientType solrClientType)
      The type of Solr client.
      Returns:
      this.

    • setSolrURL

      public SolrCommitterConfig setSolrURL(String solrURL)
      The endpoint URL used to connect to Solr (as per the client type selected).
      Returns:
      this.

    • setSolrCommitDisabled

      public SolrCommitterConfig setSolrCommitDisabled(boolean solrCommitDisabled)
      Whether to send an explicit commit request at the end of every batch, or let the server auto-commit.
      Returns:
      this.

    • setSourceIdField

      public SolrCommitterConfig setSourceIdField(String sourceIdField)
      The document field name containing the value to be stored in Solr ID field. A null value (default) will use the document reference instead of a document field.
      Returns:
      this.

    • setTargetIdField

      public SolrCommitterConfig setTargetIdField(String targetIdField)
      The name of the Solr field where to store a document unique identifier (sourceIdField). Default is "id".
      Returns:
      this.

    • setTargetContentField

      public SolrCommitterConfig setTargetContentField(String targetContentField)
      The name of the Solr field where content will be stored. Default is "content". A null value will disable storing the content.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseBatchCommitterConfig

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseBatchCommitterConfig

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseBatchCommitterConfig

    • toString

      public String toString()
      Overrides:
      toString in class BaseBatchCommitterConfig