org.broadleafcommerce.core.search.service.solr

Class FileSystemSolrIndexStatusProviderImpl

java.lang.Object

org.broadleafcommerce.core.search.service.solr.FileSystemSolrIndexStatusProviderImpl

All Implemented Interfaces:

SolrIndexStatusProvider

public class FileSystemSolrIndexStatusProviderImpl
extends Object
implements SolrIndexStatusProvider

XML based Index Status provider. Tracks current index status (last successful event id), events that have error (along with retry count), events that have exceeded the retry count and are considered dead. Also supports a period purge of the dead events to keep the XML file from growing too large.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentBuilder	builder
protected Integer	deadEventPurgeCycleSeconds
protected Integer	deadEventTTLSeconds
protected SimpleDateFormat	format
protected SearchService	searchService
protected SolrConfiguration	solrConfiguration
protected XPath	xPath

Constructor Summary

Constructors

Constructor and Description
FileSystemSolrIndexStatusProviderImpl()

Method Summary

Modifier and Type	Method and Description
protected void	clearNode(Element parentElement, String nodeName) Common routine to remove all children nodes from the passed element container
protected String	getStatusDirectory(SolrSearchServiceImpl searchService)
protected File	getStatusFile(SolrSearchServiceImpl searchService)
void	handleUpdateIndexStatus(IndexStatusInfo status) Updates the XML file with the index status, error status, and dead event status
protected void	handleUpdateIndexStatus(IndexStatusInfo status, boolean clearDeadEvents) Updates the XML file with the index status, error status, and dead event status
protected void	purgeDeadEvents(Document document, IndexStatusInfo status) Periodically purges the dead events based on solr.index.status.dead.event.purge.seconds - populating the deadEvents map in the IndexStatusInfo when it does.
IndexStatusInfo	readIndexStatus(IndexStatusInfo status) Builds the Index Status object.
protected void	updateDeadEventSegment(Document document, Element rootElement, IndexStatusInfo status, boolean clearDeadEvents) Performs the XML building for the dead event segment.
protected void	updateErrorSegment(Document document, Element rootElement, IndexStatusInfo status) Performs the XML building for the error segment
protected void	updateIndexSegment(Document document, Element rootElement, IndexStatusInfo status) Performs the XML building for the Index segment

Methods inherited from class java.lang.Object

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

Field Detail

solrConfiguration

@Qualifier(value="blCatalogSolrConfiguration")
 @Autowired(required=false)
protected SolrConfiguration solrConfiguration

searchService

protected SearchService searchService

builder

protected DocumentBuilder builder

xPath

protected XPath xPath

format

protected SimpleDateFormat format

deadEventTTLSeconds

@Value(value="${solr.index.status.dead.event.ttl.seconds:165600}")
protected Integer deadEventTTLSeconds

deadEventPurgeCycleSeconds

@Value(value="${solr.index.status.dead.event.purge.seconds:3600}")
protected Integer deadEventPurgeCycleSeconds

Constructor Detail

FileSystemSolrIndexStatusProviderImpl

public FileSystemSolrIndexStatusProviderImpl()

Method Detail

handleUpdateIndexStatus

public void handleUpdateIndexStatus(IndexStatusInfo status)

Updates the XML file with the index status, error status, and dead event status

Specified by:

handleUpdateIndexStatus in interface SolrIndexStatusProvider

handleUpdateIndexStatus

protected void handleUpdateIndexStatus(IndexStatusInfo status,
                                       boolean clearDeadEvents)

Updates the XML file with the index status, error status, and dead event status

updateIndexSegment

protected void updateIndexSegment(Document document,
                                  Element rootElement,
                                  IndexStatusInfo status)
                           throws XPathExpressionException,
                                  ParseException

Performs the XML building for the Index segment

Parameters:

document -

rootElement -

status -

Throws:

XPathExpressionException

ParseException

updateErrorSegment

protected void updateErrorSegment(Document document,
                                  Element rootElement,
                                  IndexStatusInfo status)
                           throws XPathExpressionException

Performs the XML building for the error segment

Parameters:

document -

rootElement -

status -

Throws:

XPathExpressionException

updateDeadEventSegment

protected void updateDeadEventSegment(Document document,
                                      Element rootElement,
                                      IndexStatusInfo status,
                                      boolean clearDeadEvents)
                               throws XPathExpressionException

Performs the XML building for the dead event segment. Note that this only clears the dead event node if specified.

Parameters:

document -

rootElement -

status -

Throws:

XPathExpressionException

clearNode

protected void clearNode(Element parentElement,
                         String nodeName)
                  throws XPathExpressionException

Common routine to remove all children nodes from the passed element container

Parameters:

parentElement -

nodeName -

Throws:

XPathExpressionException

readIndexStatus

public IndexStatusInfo readIndexStatus(IndexStatusInfo status)

Builds the Index Status object. Note for efficiency reasons, this typically does not return the Dead Event instances. The exception is if a purge cycle is executed.

Specified by:

readIndexStatus in interface SolrIndexStatusProvider

purgeDeadEvents

protected void purgeDeadEvents(Document document,
                               IndexStatusInfo status)
                        throws XPathExpressionException,
                               ParseException

Periodically purges the dead events based on solr.index.status.dead.event.purge.seconds - populating the deadEvents map in the IndexStatusInfo when it does.

Parameters:

document -

status -

Throws:

XPathExpressionException

ParseException

getStatusFile

protected File getStatusFile(SolrSearchServiceImpl searchService)

getStatusDirectory

protected String getStatusDirectory(SolrSearchServiceImpl searchService)