MultiTenantProductDaoImpl (broadleaf-multitenant-singleschema 4.2.0-GA API)

java.lang.Object
- com.broadleafcommerce.tenant.dao.MultiTenantProductDaoImpl

All Implemented Interfaces:: MultiTenantProductDao

@Repository(value="blMultiTenantProductDao")
public class MultiTenantProductDaoImpl
extends Object
implements MultiTenantProductDao

Author:: Phillip Verheyden (phillipuniverse), Jeff Fischer
See Also:: MultiTenantProductDao

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`CACHE_NAME`
`protected javax.cache.CacheManager`	`cacheManager`
`protected javax.persistence.EntityManager`	`em`
`protected org.broadleafcommerce.common.dao.GenericEntityDao`	`genericEntityDao`
`protected boolean`	`includeProductionIndexOptimization`
`protected org.broadleafcommerce.common.logging.SupportLogger`	`logger`
`protected javax.cache.Cache<Object,Object>`	`productOverrideCache`
`protected com.broadleafcommerce.enterprise.common.extension.tenant.RelationshipOverridesExtensionManager`	`relationOverrideExtensionManager`
`protected com.broadleafcommerce.enterprise.common.extension.tenant.RelationshipOverridesUtil`	`relationshipUtil`
`protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil`	`transUtil`
`protected boolean`	`useGlobalSolrProductOverrideCache`

Constructor Summary

Constructors
Constructor and Description

MultiTenantProductDaoImpl()

Constructors
Constructor and Description
`MultiTenantProductDaoImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<Long,Set<Long>>`	`buildUpOverriddenCatalogs(Class<?> type, javax.persistence.TypedQuery<Long> countQuery, javax.persistence.Query typeQuery, javax.persistence.Query catalogQuery)` Execute queries to retrieve standard site overridden catalogs and build up the overrides map for a particular type.
`protected Map<Long,Set<Long>>`	`buildUpProductRelationOverrides(Map<Long,Set<Long>> overrides, Map<Long,Set<Long>> skuRelOverrides)` Discover any relationship overrides to the provided overrides for the base entity.
`protected Map<Long,Set<Long>>`	`buildUpSkuRelationOverrides(Map<Long,Set<Long>> overrides)`
`protected javax.cache.Cache<Object,Object>`	`getCache()`
`protected javax.cache.CacheManager`	`getCacheManager()`
`protected Map<String,Map<Long,Set<Long>>>`	`getGlobalOverrideCache()` This cache strategy employs an in-memory cache per cluster node.
`protected Map<String,Map<Long,Set<Long>>>`	`getLocalOverrideCache()` The default cache strategy.
`Map<String,Map<Long,Set<Long>>>`	`getOverrideCache()` Get a cached map that identifies standard site catalog ids that contain entity overrides for a template catalog entity.
`protected Map<Long,Set<Long>>`	`getOverrideCatalogsForType(Class<?> requestedType)` For the specified type, find all standard site catalogs that have an overridden version of the type.
`Collection<Long>`	`getProductionOverriddenCatalogIds(org.broadleafcommerce.core.catalog.domain.Indexable indexable)` For the given master template indexable, returns a list of Catalog IDs that have an overridden version of said indexable in production.
`Collection<Long>`	`getProductionOverriddenCatalogIdsOnlyInRelationships(org.broadleafcommerce.core.catalog.domain.Product product)` Similar idea as `MultiTenantProductDao.getProductionOverriddenCatalogIdsOnlyInRelationships(Product)` except that this is only for relationships of the given product (like `CategoryProductXref`).
`protected Map<Long,Set<Long>>`	`getProductOverriddenCatalogsForSkus(Map<Long,Set<Long>> skuOverrides)`
`void`	`init()`
`void`	`updateGlobalOverrideCache(Long productId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CACHE_NAME
```
protected static final String CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - logger
```
protected org.broadleafcommerce.common.logging.SupportLogger logger
```
  - includeProductionIndexOptimization
```
@Value(value="${sandbox.include.deleted.items.production.optimization:false}")
protected boolean includeProductionIndexOptimization
```
  - em
```
protected javax.persistence.EntityManager em
```
  - transUtil
```
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil
```
  - genericEntityDao
```
protected org.broadleafcommerce.common.dao.GenericEntityDao genericEntityDao
```
  - relationshipUtil
```
protected com.broadleafcommerce.enterprise.common.extension.tenant.RelationshipOverridesUtil relationshipUtil
```
  - relationOverrideExtensionManager
```
protected com.broadleafcommerce.enterprise.common.extension.tenant.RelationshipOverridesExtensionManager relationOverrideExtensionManager
```
  - cacheManager
```
protected javax.cache.CacheManager cacheManager
```
  - useGlobalSolrProductOverrideCache
```
@Value(value="${use.global.solr.product.override.cache:false}")
protected boolean useGlobalSolrProductOverrideCache
```
  - productOverrideCache
```
protected javax.cache.Cache<Object,Object> productOverrideCache
```
- Constructor Detail
  - MultiTenantProductDaoImpl
```
public MultiTenantProductDaoImpl()
```
- Method Detail
  - init
```
@PostConstruct
public void init()
```
  - getProductionOverriddenCatalogIds
```
public Collection<Long> getProductionOverriddenCatalogIds(org.broadleafcommerce.core.catalog.domain.Indexable indexable)
```
    Description copied from interface: MultiTenantProductDao
    For the given master template indexable, returns a list of Catalog IDs that have an overridden version of said indexable in production.
    So given this scenario:
    - A Master catalog exists with ID 1
    - A Site exists with ID 2
    - Site ID 2 has its own site-specific catalog with ID 20
    - The master catalog is assigned to Site 2
    Since all edits to items from Catalog 1 only show up in Catalog 2, this will return the list [20]
    Given another scenario:
    - A Master catalog exists with ID 1
    - A Site exists with ID 2
    - Site ID 2 has its own site-specific catalog with ID 20
    - Another site ID 3 has it's own site-specific catalog with ID 30
    - THe master catalog is assigned to Site 2 and 3
    If there was an edit to the item in both Site 2 and 3, this will return the list {20, 30]
    This will look both at the clones of the given indexable as well as clones in relationships where the indexable itself would not have been cloned
    Specified by:
    
    getProductionOverriddenCatalogIds in interface MultiTenantProductDao
    
    Parameters:
    
    indexable - from the parent catalog to find overrides for
    
    Returns:
    
    the list of Catalog IDs
  - getProductionOverriddenCatalogIdsOnlyInRelationships
```
public Collection<Long> getProductionOverriddenCatalogIdsOnlyInRelationships(org.broadleafcommerce.core.catalog.domain.Product product)
```
    Description copied from interface: MultiTenantProductDao
    
    Similar idea as MultiTenantProductDao.getProductionOverriddenCatalogIdsOnlyInRelationships(Product) except that this is only for relationships of the given product (like CategoryProductXref). This is useful because if a change occurs in one of these relationships the Product does not actually get cloned, only the relationship.
    
    Specified by:
    
    getProductionOverriddenCatalogIdsOnlyInRelationships in interface MultiTenantProductDao
    
    See Also:
    
    #getProductionOverriddenCatalogIds(Indexable)}
  - getOverrideCache
```
public Map<String,Map<Long,Set<Long>>> getOverrideCache()
```
    Description copied from interface: MultiTenantProductDao
    
    Get a cached map that identifies standard site catalog ids that contain entity overrides for a template catalog entity. This is arranged overall by entity type.
    
    Specified by:
    
    getOverrideCache in interface MultiTenantProductDao
    
    Returns:
    
    the cache identifying the overriding catalogs
  - updateGlobalOverrideCache
```
public void updateGlobalOverrideCache(Long productId)
```
  - getLocalOverrideCache
```
protected Map<String,Map<Long,Set<Long>>> getLocalOverrideCache()
```
    The default cache strategy. Builds the cache once per request thread. This requires less cache maintenance overhead and is desirable in most cases.
    
    Parameters:
    
    cacheSku -
    
    Returns:
  - getProductOverriddenCatalogsForSkus
```
protected Map<Long,Set<Long>> getProductOverriddenCatalogsForSkus(Map<Long,Set<Long>> skuOverrides)
```
  - getGlobalOverrideCache
```
protected Map<String,Map<Long,Set<Long>>> getGlobalOverrideCache()
```
    This cache strategy employs an in-memory cache per cluster node. The cache is generally built at server startup. The cache state must be maintained across all the cluster nodes using events (not currently implemented). This may be advantageous for extremely large multitenant installations with large catalogs, many overrides and frequent indexing events. Set the "use.global.solr.product.override.cache" property to true in your installation's property files to enable this cache mode.
    
    Parameters:
    
    cacheSku -
    
    Returns:
  - buildUpProductRelationOverrides
```
protected Map<Long,Set<Long>> buildUpProductRelationOverrides(Map<Long,Set<Long>> overrides,
                                                              Map<Long,Set<Long>> skuRelOverrides)
```
    Discover any relationship overrides to the provided overrides for the base entity. This would apply, for example, to any changes to CategoryProductXrefImpl which should be added to the list of overrides for ProductImpl. Subclasses may override and add more relationship overrides if additional relationships are being considered as part of the solr indexing.
    
    Parameters:
    
    overrides - the overrides for the base entity (e.g. ProductImpl)
    
    Returns:
    
    a new map representing only the relationship overrides
    
    See Also:
    
    RelationshipOverridesExtensionHandler#getRelationshipOverrideCatalogsForProducts(ExtensionResultHolder)}
  - buildUpSkuRelationOverrides
```
protected Map<Long,Set<Long>> buildUpSkuRelationOverrides(Map<Long,Set<Long>> overrides)
```
  - getOverrideCatalogsForType
```
protected Map<Long,Set<Long>> getOverrideCatalogsForType(Class<?> requestedType)
```
    For the specified type, find all standard site catalogs that have an overridden version of the type. This is keyed by the id of the overridden entity in the template catalog.
    
    Parameters:
    
    requestedType - The entity class type to check
    
    Returns:
    
    All the overriding standard site catalogs
  - buildUpOverriddenCatalogs
```
protected Map<Long,Set<Long>> buildUpOverriddenCatalogs(Class<?> type,
                                                        javax.persistence.TypedQuery<Long> countQuery,
                                                        javax.persistence.Query typeQuery,
                                                        javax.persistence.Query catalogQuery)
```
    Execute queries to retrieve standard site overridden catalogs and build up the overrides map for a particular type. Do so in a paged fashion for efficiency and conservative memory usage.
    
    Parameters:
    
    type - the type to retrieve from the clone cache
    
    countQuery - the count query for items in the clone cache (used for paging)
    
    typeQuery - the query to retrieve items from the clone cache
    
    catalogQuery - the query to retrieve the overridden catalogs
    
    Returns:
    
    All the overriding standard site catalogs
  - getCacheManager
```
protected javax.cache.CacheManager getCacheManager()
```
  - getCache
```
protected javax.cache.Cache<Object,Object> getCache()
```

Class MultiTenantProductDaoImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CACHE_NAME

logger

includeProductionIndexOptimization

em

transUtil

genericEntityDao

relationshipUtil

relationOverrideExtensionManager

cacheManager

useGlobalSolrProductOverrideCache

productOverrideCache

Constructor Detail

MultiTenantProductDaoImpl

Method Detail

init

getProductionOverriddenCatalogIds

getProductionOverriddenCatalogIdsOnlyInRelationships

getOverrideCache

updateGlobalOverrideCache

getLocalOverrideCache

getProductOverriddenCatalogsForSkus

getGlobalOverrideCache

buildUpProductRelationOverrides

buildUpSkuRelationOverrides

getOverrideCatalogsForType

buildUpOverriddenCatalogs

getCacheManager

getCache