org.broadleafcommerce.core.search.service.solr.indexer

Class DefaultSolrIndexQueueProvider

java.lang.Object

org.broadleafcommerce.core.search.service.solr.indexer.DefaultSolrIndexQueueProvider

All Implemented Interfaces:

SolrIndexQueueProvider

public class DefaultSolrIndexQueueProvider
extends Object
implements SolrIndexQueueProvider

Default component to obtain a command Queue and a Lock to access the command queue. The queue should only be accessed by a single thread at a time, and so accessors must first obtain a lock. This is to prevent two threads, even across nodes, from issuing commands to Solr that might interfere with one another (e.g. re-aliasing or committing). This default implementation evaluates the SolrClient to determine whether to use a local Queue and Lock, or whether to use a distributed Queue and Lock. If the SolrClient is an instance of CloudSolrClient then this will use the associated Zookeeper to manage the lock and the queue. Otherwise, it will use a local (non-distributed) lock and queue. This can be extended to provide different queue and lock implementations. If you override them, then they both need to be distributed or local. Having a local lock and a distributed queue or vice versa will not work.

Author:

Kelly Tisdell

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCK_PATH
protected static Map<String,Lock>	LOCK_REGISTRY
static int	MAX_QUEUE_SIZE
static String	QUEUE_PATH
protected static Map<String,BlockingQueue<? super SolrUpdateCommand>>	QUEUE_REGISTRY

Fields inherited from interface org.broadleafcommerce.core.search.service.solr.indexer.SolrIndexQueueProvider

COMMAND_LOCK_NAME, COMMAND_QUEUE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultSolrIndexQueueProvider()
DefaultSolrIndexQueueProvider(org.apache.solr.client.solrj.SolrClient solrClient, org.springframework.core.env.Environment env)
DefaultSolrIndexQueueProvider(org.apache.zookeeper.ZooKeeper zookeeper, org.springframework.core.env.Environment env)

Method Summary

Modifier and Type	Method and Description
protected Lock	createDistributedLock(String lockName)
protected BlockingQueue<? super SolrUpdateCommand>	createDistributedQueue(String queueName)
protected Lock	createLocalLock(String lockName)
protected BlockingQueue<? super SolrUpdateCommand>	createLocalQueue(String queueName)
Lock	createOrRetrieveCommandLock(String lockName)
BlockingQueue<? super SolrUpdateCommand>	createOrRetrieveCommandQueue(String queueName)
protected org.springframework.core.env.Environment	getEnvironment() Returns the Environment object, which is used in a distributed situation to determine if the current node or application can obtain a lock.
protected org.apache.zookeeper.ZooKeeper	getZookeeper() Returns the ZooKeeper instance that distributes the Lock and the Queue.
boolean	isDistributed() Indicates if this is a distributed environment (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

QUEUE_REGISTRY

protected static final Map<String,BlockingQueue<? super SolrUpdateCommand>> QUEUE_REGISTRY

LOCK_REGISTRY

protected static final Map<String,Lock> LOCK_REGISTRY

MAX_QUEUE_SIZE

public static final int MAX_QUEUE_SIZE

See Also:

Constant Field Values

LOCK_PATH

public static final String LOCK_PATH

See Also:

Constant Field Values

QUEUE_PATH

public static final String QUEUE_PATH

See Also:

Constant Field Values

Constructor Detail

DefaultSolrIndexQueueProvider

public DefaultSolrIndexQueueProvider()

DefaultSolrIndexQueueProvider

public DefaultSolrIndexQueueProvider(org.apache.solr.client.solrj.SolrClient solrClient,
                                     org.springframework.core.env.Environment env)

DefaultSolrIndexQueueProvider

public DefaultSolrIndexQueueProvider(org.apache.zookeeper.ZooKeeper zookeeper,
                                     org.springframework.core.env.Environment env)

Method Detail

createOrRetrieveCommandQueue

public BlockingQueue<? super SolrUpdateCommand> createOrRetrieveCommandQueue(String queueName)

Specified by:

createOrRetrieveCommandQueue in interface SolrIndexQueueProvider

createOrRetrieveCommandLock

public Lock createOrRetrieveCommandLock(String lockName)

Specified by:

createOrRetrieveCommandLock in interface SolrIndexQueueProvider

isDistributed

public boolean isDistributed()

Indicates if this is a distributed environment (e.g. the Lock and Queue are distributed, e.g. backed by Zookeeper.)

Specified by:

isDistributed in interface SolrIndexQueueProvider

getEnvironment

protected org.springframework.core.env.Environment getEnvironment()

Returns the Environment object, which is used in a distributed situation to determine if the current node or application can obtain a lock. This may return null.

Returns:

getZookeeper

protected org.apache.zookeeper.ZooKeeper getZookeeper()

Returns the ZooKeeper instance that distributes the Lock and the Queue. This may return null in non-distributed situation.

Returns:

createLocalQueue

protected BlockingQueue<? super SolrUpdateCommand> createLocalQueue(String queueName)

createDistributedQueue

protected BlockingQueue<? super SolrUpdateCommand> createDistributedQueue(String queueName)

createLocalLock

protected Lock createLocalLock(String lockName)

createDistributedLock

protected Lock createDistributedLock(String lockName)