Package org.broadleafcommerce.core.search.service.solr.index

Interface SolrIndexStatusService

All Known Implementing Classes:

SolrIndexStatusServiceImpl

public interface SolrIndexStatusService

Responsible for reading and writing the status using one or more SolrIndexStatusProvider instances. getSeedStatusInstance() can be used to provide a custom IndexStatusInfo implementation.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method	Description
void	addIndexErrorStatus(Long eventId, Integer retryCount, Date eventCreatedDate)	Adds an error into the index status
void	addIndexStatus(Long eventId, Date eventCreatedDate)	Adds a new IndexStatusInfo given the eventId and the create date
IndexStatusInfo	getIndexStatus()	Returns a populated IndexStatusInfo instance from the provider(s)
IndexStatusInfo	getSeedStatusInstance()	Provide a custom IndexStatusInfo instance to be used by the system.
void	setIndexStatus(IndexStatusInfo status)	Adds an IndexStatusInfo entry into the status providers

Method Details

addIndexStatus

void addIndexStatus(Long eventId,
 Date eventCreatedDate)

Adds a new IndexStatusInfo given the eventId and the create date

Parameters:

eventId -

eventCreatedDate -

getIndexStatus

IndexStatusInfo getIndexStatus()

Returns a populated IndexStatusInfo instance from the provider(s)

Returns:

the index status information

setIndexStatus

void setIndexStatus(IndexStatusInfo status)

Adds an IndexStatusInfo entry into the status providers

Parameters:

status -

getSeedStatusInstance

IndexStatusInfo getSeedStatusInstance()

Provide a custom IndexStatusInfo instance to be used by the system.

Returns:

addIndexErrorStatus

void addIndexErrorStatus(Long eventId,
 Integer retryCount,
 Date eventCreatedDate)

Adds an error into the index status

Parameters:

eventId - the Id of the event that has erred

retryCount - the pre-set retry count defined in the event

eventCreatedDate - the date that the event was created