com.broadleafcommerce.tenant.service.extension.solr

Class MultiTenantSolrIndexServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

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

com.broadleafcommerce.tenant.service.extension.solr.MultiTenantSolrIndexServiceExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.extension.ExtensionHandler, org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

@Service(value="blMultiTenantSolrIndexServiceExtensionHandler")
public class MultiTenantSolrIndexServiceExtensionHandler
extends org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler
implements org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

Performs necessary modifications to Solr queries to make them multitenant compatible.

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionManager	extensionManager
protected org.broadleafcommerce.core.search.service.solr.index.SolrIndexService	indexService
protected MultiTenantProductDao	mtProductDao
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 org.broadleafcommerce.core.search.service.solr.SolrConfiguration	solrConfiguration

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
MultiTenantSolrIndexServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	attachAdditionalBasicFields(org.broadleafcommerce.core.catalog.domain.Indexable indexable, org.apache.solr.common.SolrInputDocument document, org.broadleafcommerce.core.search.service.solr.SolrHelperService shs)
protected org.broadleafcommerce.common.extension.ExtensionResultStatusType	fixSuperCatalogProductionId(Class<?> clazz, Long[] returnContainer)
protected org.broadleafcommerce.common.extension.ExtensionResultStatusType	fixSuperCatalogProductionId(org.broadleafcommerce.core.catalog.domain.Indexable indexable, Long[] returnContainer) In MultiTenant, everything in Solr should have the original ID from the catalog that it is inheriting from.
protected Long	getCatalogDiscriminator(CatalogDiscriminator discriminableEntity, Collection<Long> overriddenCatalogIds) Obtains the catalog that the product should be indexed in.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getCategoryId(Long category, Long[] returnContainer)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getIndexableId(org.broadleafcommerce.core.catalog.domain.Indexable indexable, Long[] returnContainer)
int	getPriority() This must run after the Enterprise version of this extension handler in order for fixSuperCatalogProductionId(Class, Long[]) to run afterwards
void	init()

Methods inherited from class org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

addPropertyValues, attachAdditionalDocumentFields, attachChildDocuments, endBatchEvent, modifyBuiltDocuments, populateDocumentForIndexField, startBatchEvent

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

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.core.search.service.solr.index.SolrIndexServiceExtensionHandler

addPropertyValues, attachAdditionalDocumentFields, attachChildDocuments, endBatchEvent, modifyBuiltDocuments, populateDocumentForIndexField, startBatchEvent

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

isEnabled

Field Detail

shs

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

extensionManager

protected org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionManager extensionManager

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

mtProductDao

protected MultiTenantProductDao mtProductDao

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

Constructor Detail

MultiTenantSolrIndexServiceExtensionHandler

public MultiTenantSolrIndexServiceExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

attachAdditionalBasicFields

public org.broadleafcommerce.common.extension.ExtensionResultStatusType attachAdditionalBasicFields(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                                    org.apache.solr.common.SolrInputDocument document,
                                                                                                    org.broadleafcommerce.core.search.service.solr.SolrHelperService shs)

Specified by:

attachAdditionalBasicFields in interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

Overrides:

attachAdditionalBasicFields in class org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

getCatalogDiscriminator

protected Long getCatalogDiscriminator(CatalogDiscriminator discriminableEntity,
                                       Collection<Long> overriddenCatalogIds)

Obtains the catalog that the product should be indexed in. This should almost always be what is on threadlocal at BroadleafRequestContext.getCurrentCatalog(). If nothing is on threadlocal this will use the catalog from the given discriminableEntity

Parameters:

discriminableEntity - the entity whose catalog discriminator we should obtain

overriddenCatalogIds - the catalog IDs that the given discriminableEntity has been overridden in

See Also:

MultiTenantWorkflowSolrIndexServiceExtensionHandler#modifyBuiltDocuments(java.util.ArrayList, List, List, List)}

getPriority

public int getPriority()

This must run after the Enterprise version of this extension handler in order for fixSuperCatalogProductionId(Class, Long[]) to run afterwards

Specified by:

getPriority in interface org.broadleafcommerce.common.extension.ExtensionHandler

Overrides:

getPriority in class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getCategoryId

public org.broadleafcommerce.common.extension.ExtensionResultStatusType getCategoryId(Long category,
                                                                                      Long[] returnContainer)

Specified by:

getCategoryId in interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

Overrides:

getCategoryId in class org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

getIndexableId

public org.broadleafcommerce.common.extension.ExtensionResultStatusType getIndexableId(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                       Long[] returnContainer)

Specified by:

getIndexableId in interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

Overrides:

getIndexableId in class org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

fixSuperCatalogProductionId

protected org.broadleafcommerce.common.extension.ExtensionResultStatusType fixSuperCatalogProductionId(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                                       Long[] returnContainer)

In MultiTenant, everything in Solr should have the original ID from the catalog that it is inheriting from. This solves the following problem:

1. There is a global catalog that has product ID 1
2. That global catalog is assigned to a standard site as EDITABLE
3. When edits are made on the standard site, it does not affect the global catalog. Instead, a new product is created (like with product id 10001) to hold the site-specific changes to that record.

When we get to this point in the Solr indexing, the id that is passed to us is the ID of the product in the standard site (10001 in the above example). We need to have product ID of the global catalog (1 in the above example). This will go and check the clone lib to see if this particular id was cloned from an id a master.

This will override the result that was previously placed in returnContainer (if any). Presumably, workflows/approvals would have been the one that would have attempted to give a result back for the 'real' production id. This takes that result and then uses it to look up what the inherited catalog production id is.

Parameters:

sandBoxDiscriminator -

returnContainer -

Returns:

fixSuperCatalogProductionId

protected org.broadleafcommerce.common.extension.ExtensionResultStatusType fixSuperCatalogProductionId(Class<?> clazz,
                                                                                                       Long[] returnContainer)