Package com.broadleafcommerce.search.index.core.queue

Class DefaultLocalQueueProvider

java.lang.Object

com.broadleafcommerce.search.index.core.queue.AbstractQueueProvider

com.broadleafcommerce.search.index.core.queue.DefaultLocalQueueProvider

All Implemented Interfaces:

Distributable, QueueProvider

public class DefaultLocalQueueProvider
extends AbstractQueueProvider
implements QueueProvider

A local QueueProvider that uses a DefaultLocalArrayBlockingDelegatingQueue.

Author:

Kelly Tisdell (ktisdell)

Constructor Summary

Constructors

Constructor	Description
DefaultLocalQueueProvider(int defaultMaxQueueSize)

Method Summary

Modifier and Type	Method	Description
protected <T> ReindexQueue<T>	createQueue(com.broadleafcommerce.search.api.type.IndexableType type)	Create a new queue for the given IndexableType.
protected void	destroyQueueInternal(ReindexQueue<?> queue)	Takes the necessary steps to remove or destroy the Queue, if necessary.
final boolean	isDistributed()	Indicates if this component is designed for use across JVMs.

Methods inherited from class com.broadleafcommerce.search.index.core.queue.AbstractQueueProvider

destroyQueue, getOrCreateQueue, getQueueRegistry, getQueueSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.search.index.core.queue.QueueProvider

destroyQueue, getOrCreateQueue

Constructor Details

DefaultLocalQueueProvider

public DefaultLocalQueueProvider(int defaultMaxQueueSize)

Method Details

createQueue

protected <T> ReindexQueue<T> createQueue(com.broadleafcommerce.search.api.type.IndexableType type)

Description copied from class: AbstractQueueProvider

Create a new queue for the given IndexableType.

Specified by:

createQueue in class AbstractQueueProvider

Type Parameters:

T - the type of object the queue will hold

Parameters:

type - the type to create a queue for

Returns:

a new queue for the indexable type

destroyQueueInternal

protected void destroyQueueInternal(ReindexQueue<?> queue)

Description copied from class: AbstractQueueProvider

Takes the necessary steps to remove or destroy the Queue, if necessary. Otherwise, this will be a pass-through (e.g. when the Queue is in-memory and has no cleanup requirements).

Specified by:

destroyQueueInternal in class AbstractQueueProvider

Parameters:

queue - the queue to be destroyed

isDistributed

public final boolean isDistributed()

Description copied from interface: Distributable

Indicates if this component is designed for use across JVMs.

Specified by:

isDistributed in interface Distributable

Returns:

whether this component can be distributed across JVMs