com.broadleafcommerce.tenant.service.search

Class MultiTenantWorkflowSolrIndexServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

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

com.broadleafcommerce.tenant.service.search.MultiTenantWorkflowSolrIndexServiceExtensionHandler

All Implemented Interfaces:

com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionHandler, org.broadleafcommerce.common.extension.ExtensionHandler

@Service(value="blMultiTenantWorkflowSolrIndexServiceExtensionHandler")
public class MultiTenantWorkflowSolrIndexServiceExtensionHandler
extends com.broadleafcommerce.enterprise.common.extension.search.AbstractWorkflowSolrIndexServiceExtensionHandler
implements com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionHandler

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionManager	extensionManager
protected org.broadleafcommerce.core.search.service.solr.index.SolrIndexService	indexService
protected MultiTenantProductDao	mtProductDao
protected org.broadleafcommerce.core.catalog.dao.ProductDao	productDao
protected org.broadleafcommerce.common.sandbox.SandBoxHelper	sandBoxHelper
protected org.broadleafcommerce.core.search.service.solr.SolrHelperService	shs
protected org.broadleafcommerce.common.site.service.SiteService	siteService
protected MultiTenantSiteUtil	siteUtil
protected org.broadleafcommerce.core.search.service.solr.SolrConfiguration	solrConfiguration
protected com.broadleafcommerce.enterprise.workflow.persistence.WorkflowStateManager	workflowStateManager

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
MultiTenantWorkflowSolrIndexServiceExtensionHandler()

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)
protected void	attachDeleteDocumentCatalogFields(CatalogDiscriminator catalogItem, org.apache.solr.common.SolrInputDocument doc)
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) This will build the super-catalog document.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getAdditionalDeleteQueryClause(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh)
protected List<CatalogDerivedCatalogXref>	getSyncedCopyCatalogs()
void	init()
org.broadleafcommerce.common.extension.ExtensionResultStatusType	isCurrentSiteIndexable(org.broadleafcommerce.common.extension.ExtensionResultHolder<Boolean> holder)
protected boolean	isSyncedCopyCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog, List<CatalogDerivedCatalogXref> syncedCopyCatalogs) Iterate through the given List to check if any are SYNCED_COPY and match the given catalog.

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

Field Detail

extensionManager

protected com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionManager extensionManager

mtProductDao

protected MultiTenantProductDao mtProductDao

shs

protected org.broadleafcommerce.core.search.service.solr.SolrHelperService shs

sandBoxHelper

protected org.broadleafcommerce.common.sandbox.SandBoxHelper sandBoxHelper

indexService

protected org.broadleafcommerce.core.search.service.solr.index.SolrIndexService indexService

solrConfiguration

@Qualifier(value="blCatalogSolrConfiguration")
 @Autowired(required=false)
protected org.broadleafcommerce.core.search.service.solr.SolrConfiguration solrConfiguration

siteService

protected org.broadleafcommerce.common.site.service.SiteService siteService

workflowStateManager

protected com.broadleafcommerce.enterprise.workflow.persistence.WorkflowStateManager workflowStateManager

productDao

protected org.broadleafcommerce.core.catalog.dao.ProductDao productDao

siteUtil

protected MultiTenantSiteUtil siteUtil

Constructor Detail

MultiTenantWorkflowSolrIndexServiceExtensionHandler

public MultiTenantWorkflowSolrIndexServiceExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

getAdditionalDeleteQueryClause

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

Specified by:

getAdditionalDeleteQueryClause in interface com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionHandler

Overrides:

getAdditionalDeleteQueryClause in class com.broadleafcommerce.enterprise.common.extension.search.AbstractWorkflowSolrIndexServiceExtensionHandler

attachAdditionalDeleteDocumentFields

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

Specified by:

attachAdditionalDeleteDocumentFields in interface com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionHandler

Overrides:

attachAdditionalDeleteDocumentFields in class com.broadleafcommerce.enterprise.common.extension.search.AbstractWorkflowSolrIndexServiceExtensionHandler

attachDeleteDocumentCatalogFields

protected void attachDeleteDocumentCatalogFields(CatalogDiscriminator catalogItem,
                                                 org.apache.solr.common.SolrInputDocument doc)

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

This will build the super-catalog document. At this point since all the filters are enabled in the normal buildDocument flow kicked off from Enterprise, the only document that got built was the one for the child catalog (in a hierarchical catalog structure). We have to rebuild the parent catalog item because we need to attach an overriddenCatalogIds to it

At the time of writing, the given indexableIds returns the master catalog product IDs. We should be able to read the actual catalog item from that ID and then build the document for that master catalog item. In the process of building the master catalog item the overriddenCatalogs field is added via MultiTenantSolrIndexServiceExtensionHandler.attachAdditionalBasicFields(Indexable, SolrInputDocument, SolrHelperService).

Specified by:

buildAdditionalDeploymentDocuments in interface com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionHandler

Overrides:

buildAdditionalDeploymentDocuments in class com.broadleafcommerce.enterprise.common.extension.search.AbstractWorkflowSolrIndexServiceExtensionHandler

Throws:

org.broadleafcommerce.common.exception.ServiceException

isSyncedCopyCatalog

protected boolean isSyncedCopyCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog,
                                      List<CatalogDerivedCatalogXref> syncedCopyCatalogs)

Iterate through the given List to check if any are SYNCED_COPY and match the given catalog. This is used primarily to indicates instances where we should NOT build additional deployment docs.

Parameters:

catalog - the catalog we are deriving from

syncedCopyCatalogs - the List of derived from catalogs

Returns:

true if the given catalog has a SYNCED_COPY DerivedType, false otherwise

getSyncedCopyCatalogs

protected List<CatalogDerivedCatalogXref> getSyncedCopyCatalogs()

isCurrentSiteIndexable

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

Specified by:

isCurrentSiteIndexable in interface com.broadleafcommerce.enterprise.common.extension.search.WorkflowSolrIndexServiceExtensionHandler

Overrides:

isCurrentSiteIndexable in class com.broadleafcommerce.enterprise.common.extension.search.AbstractWorkflowSolrIndexServiceExtensionHandler