org.broadleafcommerce.core.search.service.solr

Class SolrContext

java.lang.Object

org.broadleafcommerce.core.search.service.solr.SolrContext

public class SolrContext
extends Object

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 static org.apache.solr.client.solrj.SolrClient	adminServer
static String	PRIMARY
protected static org.apache.solr.client.solrj.SolrClient	primaryServer
static String	REINDEX
protected static org.apache.solr.client.solrj.SolrClient	reindexServer

Constructor Summary

Constructors

Constructor and Description
SolrContext()

Method Summary

Modifier and Type	Method and Description
static org.apache.solr.client.solrj.SolrClient	getAdminServer() The adminServer is just a reference to a SolrClient component for connecting to Solr.
static org.apache.solr.client.solrj.SolrClient	getReindexServer()
static org.apache.solr.client.solrj.SolrClient	getServer()
static boolean	isSingleCoreMode()
static boolean	isSolrCloudMode() Indicates if we are communicating with SolrCloud, rather than embedded, or Stand-alone Solr server(s).
static void	setAdminServer(org.apache.solr.client.solrj.SolrClient server) Sets the admin SolrClient instance to communicate with Solr for administrative reasons, like swapping cores.
static void	setPrimaryServer(org.apache.solr.client.solrj.SolrClient server) Sets the primary SolrClient instance to communicate with Solr.
static 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.

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY

public static final String PRIMARY

See Also:

Constant Field Values

REINDEX

public static final String REINDEX

See Also:

Constant Field Values

adminServer

protected static org.apache.solr.client.solrj.SolrClient adminServer

primaryServer

protected static org.apache.solr.client.solrj.SolrClient primaryServer

reindexServer

protected static org.apache.solr.client.solrj.SolrClient reindexServer

Constructor Detail

SolrContext

public SolrContext()

Method Detail

setPrimaryServer

public static void setPrimaryServer(org.apache.solr.client.solrj.SolrClient server)

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 -

setReindexServer

public static 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. 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 -

setAdminServer

public static 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 static 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 static org.apache.solr.client.solrj.SolrClient getServer()

Returns:

the primary Solr server

getReindexServer

public static org.apache.solr.client.solrj.SolrClient getReindexServer()

Returns:

the primary server if isSingleCoreMode(), else the reindex server

isSingleCoreMode

public static boolean isSingleCoreMode()

Returns:

if this Solr context has a reindex server set not

isSolrCloudMode

public static boolean isSolrCloudMode()

Indicates if we are communicating with SolrCloud, rather than embedded, or Stand-alone Solr server(s). This is important to know because Solr cloud is clustered, uses sharding, uses Zookeeper to manage state, and manages individual "collections" rather than "cores" for searching and reindexing.

Returns: