com.broadleafcommerce.enterprise.common.extension.search

Class AbstractWorkflowSolrIndexServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

com.broadleafcommerce.enterprise.common.extension.search.AbstractWorkflowSolrIndexServiceExtensionHandler

All Implemented Interfaces:

WorkflowSolrIndexServiceExtensionHandler, org.broadleafcommerce.common.extension.ExtensionHandler

public abstract class AbstractWorkflowSolrIndexServiceExtensionHandler
extends org.broadleafcommerce.common.extension.AbstractExtensionHandler
implements WorkflowSolrIndexServiceExtensionHandler

Author:

Andre Azzolini (apazzolini), Phillip Verheyden (phillipuniverse)

Field Summary

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractWorkflowSolrIndexServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	attachAdditionalDeleteDocumentFields(org.broadleafcommerce.core.catalog.domain.Indexable indexable, org.apache.solr.common.SolrInputDocument doc) When a product is deleted in the sandbox, a new Solr document is created that represents the deleted item.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	buildAdditionalDeploymentDocuments(List<Long> indexableIds, List<? extends org.broadleafcommerce.core.catalog.domain.Indexable> indexables, List<org.apache.solr.common.SolrInputDocument> builtDocs) Invoked after documents are built on a DeployState.PRODUCTION deployment in Enterprise
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getAdditionalDeleteQueryClause(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh) Returns additional strings to append to the production delete query for Solr indexing
org.broadleafcommerce.common.extension.ExtensionResultStatusType	isCurrentSiteIndexable(org.broadleafcommerce.common.extension.ExtensionResultHolder<Boolean> holder)

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Constructor Detail

AbstractWorkflowSolrIndexServiceExtensionHandler

public AbstractWorkflowSolrIndexServiceExtensionHandler()

Method Detail

getAdditionalDeleteQueryClause

public org.broadleafcommerce.common.extension.ExtensionResultStatusType getAdditionalDeleteQueryClause(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh)

Description copied from interface: WorkflowSolrIndexServiceExtensionHandler

Returns additional strings to append to the production delete query for Solr indexing

Specified by:

getAdditionalDeleteQueryClause in interface WorkflowSolrIndexServiceExtensionHandler

Returns:

whether or not the ExtensionResultHolder has a String

attachAdditionalDeleteDocumentFields

public org.broadleafcommerce.common.extension.ExtensionResultStatusType attachAdditionalDeleteDocumentFields(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                                             org.apache.solr.common.SolrInputDocument doc)

Description copied from interface: WorkflowSolrIndexServiceExtensionHandler

When a product is deleted in the sandbox, a new Solr document is created that represents the deleted item. This method provides the opportunity to customize the fields that are attached to the given doc

Specified by:

attachAdditionalDeleteDocumentFields in interface WorkflowSolrIndexServiceExtensionHandler

buildAdditionalDeploymentDocuments

public org.broadleafcommerce.common.extension.ExtensionResultStatusType buildAdditionalDeploymentDocuments(List<Long> indexableIds,
                                                                                                           List<? extends org.broadleafcommerce.core.catalog.domain.Indexable> indexables,
                                                                                                           List<org.apache.solr.common.SolrInputDocument> builtDocs)
                                                                                                    throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: WorkflowSolrIndexServiceExtensionHandler

Invoked after documents are built on a DeployState.PRODUCTION deployment in Enterprise

Specified by:

buildAdditionalDeploymentDocuments in interface WorkflowSolrIndexServiceExtensionHandler

Parameters:

indexableIds - the original id set passed to com.broadleafcommerce.enterprise.workflow.service.search.WorkflowSolrIndexService#getSolrDocuments

indexables - corresponds to the database-backed entities of indexableIds. Assuming the default filters were enabled (which is the default) this should be the same size as indexableIds

builtDocs - the SolrInputDocuments that were already built naturally from a deployment event

Returns:

Throws:

org.broadleafcommerce.common.exception.ServiceException

isCurrentSiteIndexable

public org.broadleafcommerce.common.extension.ExtensionResultStatusType isCurrentSiteIndexable(org.broadleafcommerce.common.extension.ExtensionResultHolder<Boolean> holder)

Specified by:

isCurrentSiteIndexable in interface WorkflowSolrIndexServiceExtensionHandler