SolrConfiguration (BroadleafCommerce Framework 5.1.1-GA API)

java.lang.Object
- org.broadleafcommerce.core.search.service.solr.SolrConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean
```
public class SolrConfiguration
extends Object
implements org.springframework.beans.factory.InitializingBean
```
Provides a class that will statically hold the Solr server.
This is initialized in SolrSearchServiceImpl and used in SolrIndexServiceImpl

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.solr.client.solrj.SolrClient`	`adminServer`
`protected String`	`namespace`
`protected String`	`primaryName`
`protected org.apache.solr.client.solrj.SolrClient`	`primaryServer`
`protected String`	`reindexName`
`protected org.apache.solr.client.solrj.SolrClient`	`reindexServer`
`protected String`	`siteAliasBase`
`protected String`	`siteCollectionBase`
`protected boolean`	`siteCollections`
`protected String`	`solrCloudConfigName`
`protected Integer`	`solrCloudNumShards`
`protected String`	`solrHomePath`

Constructor Summary

Constructors
Constructor and Description
`SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer, org.apache.solr.client.solrj.SolrClient reindexServer, org.apache.solr.client.solrj.SolrClient adminServer)` Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing.
`SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer, org.apache.solr.client.solrj.SolrClient reindexServer, org.apache.solr.client.solrj.SolrClient adminServer, String namespace)` Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing.
`SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer, org.apache.solr.client.solrj.SolrClient reindexServer, org.apache.solr.client.solrj.SolrClient adminServer, String primaryCoreName, String reindexCoreName)` Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing.
`SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer, org.apache.solr.client.solrj.SolrClient reindexServer, org.apache.solr.client.solrj.SolrClient adminServer, String primaryCoreName, String reindexCoreName, String namespace)` Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing.
`SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer, org.apache.solr.client.solrj.SolrClient reindexServer, String solrCloudConfigName, int solrCloudNumShards)` This constructor should be used to set up Solr Cloud using solr cloud config name, number of cloud shards, and multiple clients, one primary, and one for reindexing to reduce down time during indexing.
`SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer, org.apache.solr.client.solrj.SolrClient reindexServer, String solrCloudConfigName, int solrCloudNumShards, String namespace)` This constructor should be used to set up Solr Cloud using solr cloud config name, number of cloud shards, and multiple clients, one primary, and one for reindexing to reduce down time during indexing.
`SolrConfiguration(String solrServer)` This constructor should be used to set up embedded solr given a String to a SolrHome directory to use, or if 'solrhome' is passed in as a parameter we will use the java temp directory to setup solr

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected void`	`buildSolrCoreDirectories(String solrServer)` This creates the proper directories and writes the correct properties files for Solr to run in embedded mode.
`void`	`copyConfigToSolrHome(InputStream configIs, File destFile)`
`protected void`	`createAliasIfNotExist(org.apache.solr.client.solrj.impl.CloudSolrClient client, String collectionName, String aliasName)`
`protected void`	`createCollectionIfNotExist(org.apache.solr.client.solrj.impl.CloudSolrClient client, String collectionName)`
`void`	`destroy()`
`protected String`	`determineCoreName(org.apache.solr.client.solrj.impl.HttpSolrClient httpSolrClient)`
`org.apache.solr.client.solrj.SolrClient`	`getAdminServer()` The adminServer is just a reference to a SolrClient component for connecting to Solr.
`String`	`getNamespace()`
`String`	`getPrimaryName()`
`String`	`getReindexName()`
`org.apache.solr.client.solrj.SolrClient`	`getReindexServer()`
`org.apache.solr.client.solrj.SolrClient`	`getServer()`
`protected String`	`getSiteAliasBase()`
`protected String`	`getSiteAliasName(Site site)`
`protected String`	`getSiteCollectionBase()`
`protected String`	`getSiteCollectionName(Site site)`
`protected String`	`getSiteReindexAliasName(Site site)`
`protected String`	`getSiteReindexCollectionName(Site site)`
`org.apache.solr.client.solrj.SolrClient`	`getSiteReindexServer()`
`org.apache.solr.client.solrj.SolrClient`	`getSiteServer()`
`String`	`getSolrCloudConfigName()`
`Integer`	`getSolrCloudNumShards()`
`String`	`getSolrHomePath()`
`boolean`	`isSingleCoreMode()`
`boolean`	`isSiteCollections()`
`boolean`	`isSolrCloudMode()`
`void`	`setAdminServer(org.apache.solr.client.solrj.SolrClient server)` Sets the admin SolrClient instance to communicate with Solr for administrative reasons, like swapping cores.
`void`	`setNamespace(String namespace)`
`void`	`setPrimaryName(String primaryName)`
`void`	`setReindexName(String reindex)`
`void`	`setReindexServer(org.apache.solr.client.solrj.SolrClient server)` Sets the SolrClient instance that points to the reindex core for the purpose of doing a full reindex, while the primary core is still serving serving requests.
`void`	`setServer(org.apache.solr.client.solrj.SolrClient server)` Sets the primary SolrClient instance to communicate with Solr.
`void`	`setSiteAliasBase(String siteAliasBase)`
`void`	`setSiteCollectionBase(String siteCollectionBase)`
`void`	`setSiteCollections(boolean siteCollections)`
`void`	`setSolrCloudConfigName(String solrCloudConfigName)`
`void`	`setSolrCloudNumShards(int solrCloudNumShards)`
`void`	`setSolrCloudNumShards(Integer solrCloudNumShards)`
`void`	`setSolrHomePath(String solrHomePath)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - primaryName
```
protected String primaryName
```
  - reindexName
```
protected String reindexName
```
  - namespace
```
protected String namespace
```
  - adminServer
```
protected org.apache.solr.client.solrj.SolrClient adminServer
```
  - primaryServer
```
protected org.apache.solr.client.solrj.SolrClient primaryServer
```
  - reindexServer
```
protected org.apache.solr.client.solrj.SolrClient reindexServer
```
  - solrCloudConfigName
```
protected String solrCloudConfigName
```
  - solrCloudNumShards
```
protected Integer solrCloudNumShards
```
  - solrHomePath
```
protected String solrHomePath
```
  - siteCollections
```
@Value(value="${solr.index.site.collections:false}")
protected boolean siteCollections
```
  - siteAliasBase
```
@Value(value="${solr.index.site.alias.name:site}")
protected String siteAliasBase
```
  - siteCollectionBase
```
@Value(value="${solr.index.site.collection.name:blcSite}")
protected String siteCollectionBase
```
- Constructor Detail
  - SolrConfiguration
```
public SolrConfiguration(String solrServer)
                  throws IOException,
                         ParserConfigurationException,
                         SAXException,
                         javax.jms.IllegalStateException
```
    This constructor should be used to set up embedded solr given a String to a SolrHome directory to use, or if 'solrhome' is passed in as a parameter we will use the java temp directory to setup solr
    
    Parameters:
    solrServer -
    
    Throws:
    
    IOException
    
    ParserConfigurationException
    
    SAXException
    
    javax.jms.IllegalStateException
  - SolrConfiguration
```
public SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer,
                 org.apache.solr.client.solrj.SolrClient reindexServer,
                 org.apache.solr.client.solrj.SolrClient adminServer)
                  throws javax.jms.IllegalStateException
```
    Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing. This constructor should be used when setting up HttpSolrClient since no collection names are being provided. The adminServer is just a reference to a SolrClient component for connecting to Solr. In newer versions of Solr, 4.4 and beyond, auto discovery of cores is provided. When using a stand-alone server or server cluster, the admin server, for swapping cores, is a different URL. For example, one needs to use http://solrserver:8983/solr, which formerly acted as the admin server AND as the primary core. As of Solr 4.4, one needs to specify the cores separately: http://solrserver:8983/solr/primary and http://solrserver:8983/solr/reindex, and use http://solrserver:8983/solr for swapping cores.
    
    Parameters:
    solrServer -
    reindexServer -
    adminServer -
    
    Throws:
    
    javax.jms.IllegalStateException
  - SolrConfiguration
```
public SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer,
                 org.apache.solr.client.solrj.SolrClient reindexServer,
                 org.apache.solr.client.solrj.SolrClient adminServer,
                 String namespace)
                  throws javax.jms.IllegalStateException
```
    Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing. This constructor should be used when setting up HttpSolrClient since no collection names are being provided. Namespace can be specified if managing multiple document sets within the same cores. The adminServer is just a reference to a SolrClient component for connecting to Solr. In newer versions of Solr, 4.4 and beyond, auto discovery of cores is provided. When using a stand-alone server or server cluster, the admin server, for swapping cores, is a different URL. For example, one needs to use http://solrserver:8983/solr, which formerly acted as the admin server AND as the primary core. As of Solr 4.4, one needs to specify the cores separately: http://solrserver:8983/solr/primary and http://solrserver:8983/solr/reindex, and use http://solrserver:8983/solr for swapping cores.
    
    Parameters:
    solrServer -
    reindexServer -
    adminServer -
    namespace -
    
    Throws:
    
    javax.jms.IllegalStateException
  - SolrConfiguration
```
public SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer,
                 org.apache.solr.client.solrj.SolrClient reindexServer,
                 org.apache.solr.client.solrj.SolrClient adminServer,
                 String primaryCoreName,
                 String reindexCoreName)
                  throws javax.jms.IllegalStateException
```
    Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing. This constructor should be used when setting up LBHttpSolrClients because primaryCoreName and reindexCoreName need to be provided to SolrConfiguration. The adminServer is just a reference to a SolrClient component for connecting to Solr. In newer versions of Solr, 4.4 and beyond, auto discovery of cores is provided. When using a stand-alone server or server cluster, the admin server, for swapping cores, is a different URL. For example, one needs to use http://solrserver:8983/solr, which formerly acted as the admin server AND as the primary core. As of Solr 4.4, one needs to specify the cores separately: http://solrserver:8983/solr/primary and http://solrserver:8983/solr/reindex, and use http://solrserver:8983/solr for swapping cores.
    
    Parameters:
    solrServer -
    reindexServer -
    adminServer -
    primaryCoreName -
    reindexCoreName -
    
    Throws:
    
    javax.jms.IllegalStateException
  - SolrConfiguration
```
public SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer,
                 org.apache.solr.client.solrj.SolrClient reindexServer,
                 org.apache.solr.client.solrj.SolrClient adminServer,
                 String primaryCoreName,
                 String reindexCoreName,
                 String namespace)
                  throws javax.jms.IllegalStateException
```
    Sets up Solr using multiple clients, one primary, one for reindexing, and one admin to reduce down time during indexing. This constructor should be used when setting up LBHttpSolrClients because primaryCoreName and reindexCoreName need to be provided to SolrConfiguration. Namespace can be specified if managing multiple document sets within the same cores. The adminServer is just a reference to a SolrClient component for connecting to Solr. In newer versions of Solr, 4.4 and beyond, auto discovery of cores is provided. When using a stand-alone server or server cluster, the admin server, for swapping cores, is a different URL. For example, one needs to use http://solrserver:8983/solr, which formerly acted as the admin server AND as the primary core. As of Solr 4.4, one needs to specify the cores separately: http://solrserver:8983/solr/primary and http://solrserver:8983/solr/reindex, and use http://solrserver:8983/solr for swapping cores.
    
    Parameters:
    solrServer -
    reindexServer -
    adminServer -
    primaryCoreName -
    reindexCoreName -
    namespace -
    
    Throws:
    
    javax.jms.IllegalStateException
  - SolrConfiguration
```
public SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer,
                 org.apache.solr.client.solrj.SolrClient reindexServer,
                 String solrCloudConfigName,
                 int solrCloudNumShards)
                  throws javax.jms.IllegalStateException
```
    This constructor should be used to set up Solr Cloud using solr cloud config name, number of cloud shards, and multiple clients, one primary, and one for reindexing to reduce down time during indexing. Be sure to set the defaultCollection on the SolrClients correctly before passing them to this constructor.
    
    Parameters:
    solrServer -
    reindexServer -
    solrCloudConfigName -
    solrCloudNumShards -
    
    Throws:
    
    javax.jms.IllegalStateException
  - SolrConfiguration
```
public SolrConfiguration(org.apache.solr.client.solrj.SolrClient solrServer,
                 org.apache.solr.client.solrj.SolrClient reindexServer,
                 String solrCloudConfigName,
                 int solrCloudNumShards,
                 String namespace)
                  throws javax.jms.IllegalStateException
```
    This constructor should be used to set up Solr Cloud using solr cloud config name, number of cloud shards, and multiple clients, one primary, and one for reindexing to reduce down time during indexing. Be sure to set the defaultCollection on the SolrClients correctly before passing them to this constructor. Namespace can be specified if managing multiple document sets within the same collections.
    
    Parameters:
    solrServer -
    reindexServer -
    solrCloudConfigName -
    solrCloudNumShards -
    namespace -
    
    Throws:
    
    javax.jms.IllegalStateException
- Method Detail
  - getPrimaryName
```
public String getPrimaryName()
```
  - setPrimaryName
```
public void setPrimaryName(String primaryName)
```
  - getReindexName
```
public String getReindexName()
```
  - setReindexName
```
public void setReindexName(String reindex)
```
  - getSolrCloudConfigName
```
public String getSolrCloudConfigName()
```
  - setSolrCloudConfigName
```
public void setSolrCloudConfigName(String solrCloudConfigName)
```
  - getSolrCloudNumShards
```
public Integer getSolrCloudNumShards()
```
  - setSolrCloudNumShards
```
public void setSolrCloudNumShards(Integer solrCloudNumShards)
```
  - getSolrHomePath
```
public String getSolrHomePath()
```
  - setSolrHomePath
```
public void setSolrHomePath(String solrHomePath)
```
  - getNamespace
```
public String getNamespace()
```
  - setNamespace
```
public void setNamespace(String namespace)
```
  - setServer
```
public void setServer(org.apache.solr.client.solrj.SolrClient server)
               throws javax.jms.IllegalStateException
```
    Sets the primary SolrClient instance to communicate with Solr. This is typically one of the following: org.apache.solr.client.solrj.embedded.EmbeddedSolrClient, org.apache.solr.client.solrj.impl.HttpSolrClient, org.apache.solr.client.solrj.impl.LBHttpSolrClient, or org.apache.solr.client.solrj.impl.CloudSolrClient
    
    Parameters:
    server -
    
    Throws:
    
    javax.jms.IllegalStateException
  - setReindexServer
```
public void setReindexServer(org.apache.solr.client.solrj.SolrClient server)
                      throws javax.jms.IllegalStateException
```
    Sets the SolrClient instance that points to the reindex core for the purpose of doing a full reindex, while the primary core is still serving serving requests. This is typically one of the following: org.apache.solr.client.solrj.embedded.EmbeddedSolrServer, org.apache.solr.client.solrj.impl.HttpSolrServer, org.apache.solr.client.solrj.impl.LBHttpSolrServer, or org.apache.solr.client.solrj.impl.CloudSolrClient
    
    Parameters:
    server -
    
    Throws:
    
    javax.jms.IllegalStateException
  - setAdminServer
```
public void setAdminServer(org.apache.solr.client.solrj.SolrClient server)
```
    Sets the admin SolrClient instance to communicate with Solr for administrative reasons, like swapping cores. This is typically one of the following: org.apache.solr.client.solrj.embedded.EmbeddedSolrServer, org.apache.solr.client.solrj.impl.HttpSolrServer, org.apache.solr.client.solrj.impl.LBHttpSolrServer, or org.apache.solr.client.solrj.impl.CloudSolrClient This should not typically need to be set unless using a stand-alone configuration, where the path to the /admin URI is different than the core URI. This should not typically be set for EmbeddedSolrServer or CloudSolrClient.
    
    Parameters:
    server -
  - getAdminServer
```
public org.apache.solr.client.solrj.SolrClient getAdminServer()
```
    The adminServer is just a reference to a SolrClient component for connecting to Solr. In newer versions of Solr, 4.4 and beyond, auto discovery of cores is provided. When using a stand-alone server or server cluster, the admin server, for swapping cores, is a different URL. For example, one needs to use http://solrserver:8983/solr, which formerly acted as the admin server AND as the primary core. As of Solr 4.4, one needs to specify the cores separately: http://solrserver:8983/solr/primary and http://solrserver:8983/solr/reindex, and use http://solrserver:8983/solr for swapping cores. By default, this method attempts to return an admin server if configured. Otherwise, it returns the primary server if the admin server is null, which is backwards compatible with the way that BLC worked prior to this change.
    
    Returns:
  - getServer
```
public org.apache.solr.client.solrj.SolrClient getServer()
```
    Returns:
    the primary Solr server
  - getReindexServer
```
public org.apache.solr.client.solrj.SolrClient getReindexServer()
```
    Returns:
    the primary server if isSingleCoreMode(), else the reindex server
  - isSingleCoreMode
```
public boolean isSingleCoreMode()
```
    Returns:
    if this Solr context has a reindex server set not
  - isSolrCloudMode
```
public boolean isSolrCloudMode()
```
  - copyConfigToSolrHome
```
public void copyConfigToSolrHome(InputStream configIs,
                        File destFile)
                          throws IOException
```
    Throws:
    
    IOException
  - buildSolrCoreDirectories
```
protected void buildSolrCoreDirectories(String solrServer)
                                 throws IOException
```
    This creates the proper directories and writes the correct properties files for Solr to run in embedded mode.
    
    Parameters:
    solrServer -
    
    Throws:
    
    IOException
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws org.apache.solr.client.solrj.SolrServerException,
                               IOException,
                               javax.jms.IllegalStateException
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    org.apache.solr.client.solrj.SolrServerException
    
    IOException
    
    javax.jms.IllegalStateException
  - getSiteServer
```
public org.apache.solr.client.solrj.SolrClient getSiteServer()
```
  - getSiteReindexServer
```
public org.apache.solr.client.solrj.SolrClient getSiteReindexServer()
```
  - createCollectionIfNotExist
```
protected void createCollectionIfNotExist(org.apache.solr.client.solrj.impl.CloudSolrClient client,
                              String collectionName)
```
  - createAliasIfNotExist
```
protected void createAliasIfNotExist(org.apache.solr.client.solrj.impl.CloudSolrClient client,
                         String collectionName,
                         String aliasName)
```
  - getSiteAliasName
```
protected String getSiteAliasName(Site site)
```
    Parameters:
    site - the Site
    
    Returns:
    the alias name for the given Site
  - getSiteCollectionName
```
protected String getSiteCollectionName(Site site)
```
    Parameters:
    site - the Site
    
    Returns:
    the collection name for the given Site
  - getSiteReindexAliasName
```
protected String getSiteReindexAliasName(Site site)
```
    Parameters:
    site - the Site
    
    Returns:
    the reindex alias name for the given Site
  - getSiteReindexCollectionName
```
protected String getSiteReindexCollectionName(Site site)
```
    Parameters:
    site - the Site
    
    Returns:
    the reindex collection name for the given Site
  - getSiteAliasBase
```
protected String getSiteAliasBase()
```
  - getSiteCollectionBase
```
protected String getSiteCollectionBase()
```
  - isSiteCollections
```
public boolean isSiteCollections()
```
    Returns:
    whether to index a separate collection per site
  - setSiteAliasBase
```
public void setSiteAliasBase(String siteAliasBase)
```
  - setSiteCollectionBase
```
public void setSiteCollectionBase(String siteCollectionBase)
```
  - setSiteCollections
```
public void setSiteCollections(boolean siteCollections)
```
  - setSolrCloudNumShards
```
public void setSolrCloudNumShards(int solrCloudNumShards)
```
  - determineCoreName
```
protected String determineCoreName(org.apache.solr.client.solrj.impl.HttpSolrClient httpSolrClient)
```
  - destroy
```
public void destroy()
             throws Exception
```
    Throws:
    
    Exception

Class SolrConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

primaryName

reindexName

namespace

adminServer

primaryServer

reindexServer

solrCloudConfigName

solrCloudNumShards

solrHomePath

siteCollections

siteAliasBase

siteCollectionBase

Constructor Detail

SolrConfiguration

SolrConfiguration

SolrConfiguration

SolrConfiguration

SolrConfiguration

SolrConfiguration

SolrConfiguration

Method Detail

getPrimaryName

setPrimaryName

getReindexName

setReindexName

getSolrCloudConfigName

setSolrCloudConfigName

getSolrCloudNumShards

setSolrCloudNumShards

getSolrHomePath

setSolrHomePath

getNamespace

setNamespace

setServer

setReindexServer

setAdminServer

getAdminServer

getServer

getReindexServer

isSingleCoreMode

isSolrCloudMode

copyConfigToSolrHome

buildSolrCoreDirectories

afterPropertiesSet

getSiteServer

getSiteReindexServer

createCollectionIfNotExist

createAliasIfNotExist

getSiteAliasName

getSiteCollectionName

getSiteReindexAliasName

getSiteReindexCollectionName

getSiteAliasBase

getSiteCollectionBase

isSiteCollections

setSiteAliasBase

setSiteCollectionBase

setSiteCollections

setSolrCloudNumShards

determineCoreName

destroy