com.broadleafcommerce.tenant.service.cache

Class SparseOverridePreCacheServiceImpl

java.lang.Object

com.broadleafcommerce.tenant.service.cache.SparseOverridePreCacheServiceImpl

All Implemented Interfaces:

org.broadleafcommerce.common.cache.OverridePreCacheService, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class SparseOverridePreCacheServiceImpl
extends Object
implements org.springframework.context.SmartLifecycle, org.broadleafcommerce.common.cache.OverridePreCacheService

True multitenant implementation of OverridePreCacheService. This implementation will review WorkflowCloneLibrary instances to find any and all production, standard site overrides that are qualified. Then it will review and cache the entities referenced in those override declarations. This serves as a fast cache for site-level overrides.

The cache has several grooming strategies.

• groomCacheBySiteOverride(String, Long, boolean) will add or remove a cache member based on a WorkflowCloneLibrary change
• groomCacheByTargetEntity(String, Serializable) will update the value of an existing member in the cache
• refreshCache() can be called explicitly to destroy and rebuild the cache. This is done in a thread safe and read efficient way.

The cache is generally groomed in response to system events. See SparseSiteOverrideSystemEventConsumer and SparseOverrideEntityInvalidationSystemEventConsumer for the specific event listeners.

This cache is disabled by default. Set the 'precached.sparse.override.cache.enable' property to true to enable.

This implementation employs an Ehcache cache to hold the values. The cache is configured to be eternal and to roll over to disk with a default of 5000 elements retained in memory. You can control the size of the in-memory portion of the cache by setting the 'precached.sparse.override.max.elements.inmemory' property.

This implementation also uses a scheduled task to call the refreshCache() method on an interval. This serves as a fail-safe should normal cache grooming be ineffectual. The default interval is 3600000 ms (1 hour) and can be controlled via the 'precached.sparse.override.refresh.interval.millis' property.

By default, even if enabled, the cache will be inactive until one or more SparseOverridePreCacheQualifiedEntityPattern beans are registered. This class allows for flexible include/exclude configuration of entity types based on regular expressions. You generally configure your patterns in your application context or Configuration class. Here is an example in xml:

 
    <bean id="myPatterns" class="org.springframework.beans.factory.config.ListFactoryBean">
        <property name="sourceList">
            <list>
                <bean class="com.broadleafcommerce.tenant.service.cache.SparseOverridePreCacheQualifiedEntityPattern">
                    <property name="include" value="true"/>
                    <property name="regex" value=".*(Translation|TranslationImpl)"/>
                </bean>
            </list>
        </property>
    </bean>

    <bean class="org.broadleafcommerce.common.extensibility.context.merge.LateStageMergeBeanPostProcessor">
        <property name="collectionRef" value="myPatterns" />
        <property name="targetRef" value="blPreCachedSparseOverrideQualifiedEntityPatterns" />
    </bean>
 
 

Note, this cache is generally used in conjuction with one or more override strategies. See these strategies for more information:

• org.broadleafcommerce.common.i18n.service.SparseTranslationOverrideStrategy
• com.broadleafcommerce.i18n.enterprise.config.service.SparseInternationalMessageOverrideStrategy
• com.broadleafcommerce.pricelist.dao.SparsePriceListOverrideStrategy

To enable the SparseTranslationOverrideStrategy, add a include SparseOverridePreCacheQualifiedEntityPattern with a regex of '.*(Translation|TranslationImpl)'. To enable SparseInternationalMessageOverrideStrategy, add a include SparseOverridePreCacheQualifiedEntityPattern with a regex of '.*(InternationalMessage|InternationalMessageImpl)'. To enable SparsePriceListOverrideStrategy, add a include SparseOverridePreCacheQualifiedEntityPattern with a regex of '.*(SkuPriceData|SkuPriceDataImpl)'. These override strategies generally depend on this service being active and qualified for each type (via a qualified entity pattern) to be operational.

This cache also keeps track of isolated standard site overrides by type. This information is useful during template only query determinations. Normally, template only queries can be optimized to only look at template catalogs or profiles, which makes those queries re-usable across sites from cache. However, if a standard site has isolated values for that type (i.e. a new instance of the type has been created in the site without inheriting it from a profile or catalog), then a query for that site must include the standard site in the where clause, rather than ignore it. This isolated site override cache allows the sparse override strategy to make the proper call at runtime on whether or not it can leverage a more optimized template query for the current site. See isActiveIsolatedSiteForType(Long, String).

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cloneCount
protected javax.cache.Cache	currentCache
protected javax.persistence.EntityManager	em
protected boolean	enabled
protected boolean	groomingEnabled
protected List<org.broadleafcommerce.common.cache.OverridePreCacheInitializer>	handlers
protected boolean	isStarted
protected org.broadleafcommerce.common.extensibility.cache.JCacheUtil	jcacheUtil
protected ReadWriteLock	lock
protected int	maxElementsInMemory
protected List<SparseOverridePreCacheQualifiedEntityPattern>	qualifiedEntityPatterns
protected long	refreshInterval
protected Map<String,Set<Long>>	sitesWithIsolatedValuesByType
protected Timer	timer
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil
protected ConcurrentHashMap<String,Boolean>	typeStatus

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
SparseOverridePreCacheServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	applyToCache(Class<?> type, List<Long> sitesWithIsolatedValues, Map<String,Set<Long>> isolatedSiteCache)
protected void	applyToCache(Class<?> type, List results, javax.cache.Cache cache, boolean isRemove)
List<org.broadleafcommerce.common.extension.StandardCacheItem>	findElements(String... cacheKeys)
javax.cache.Cache	getCurrentCache()
protected List	getFullCacheResults(String qualifiedType, Class<?> type, javax.persistence.EntityManager em)
List<org.broadleafcommerce.common.cache.OverridePreCacheInitializer>	getHandlers()
int	getPhase()
List<SparseOverridePreCacheQualifiedEntityPattern>	getQualifiedEntityPatterns()
protected List<String>	getQualifiedTypes(javax.persistence.EntityManager em)
protected List<Long>	getStandardSitesContainingIsolatedValues(Class<?> type, javax.persistence.EntityManager em)
protected List<String>	getStaticQualifiedTypes(javax.persistence.EntityManager em)
protected Class<?>	getType(String entityType)
void	groomCacheBySiteOverride(String entityType, Long cloneId, boolean isRemove)
void	groomCacheByTargetEntity(String entityType, Serializable id)
boolean	isActiveForType(String type)
boolean	isActiveIsolatedSiteForType(Long siteId, String entityType)
boolean	isAutoStartup()
boolean	isEnabled()
boolean	isGroomingEnabled()
boolean	isRunning()
protected void	populateCache(javax.persistence.EntityManager em, List<String> qualifiedTypes, javax.cache.Cache clone)
protected void	populateCache(javax.persistence.EntityManager em, List<String> staticQualifiedTypes, Map<String,Set<Long>> isolatedSiteCache)
void	refreshCache()
void	setCurrentCache(javax.cache.Cache currentCache)
void	setEnabled(boolean enabled)
void	setGroomingEnabled(boolean groomingEnabled)
void	setHandlers(List<org.broadleafcommerce.common.cache.OverridePreCacheInitializer> handlers)
void	setQualifiedEntityPatterns(List<SparseOverridePreCacheQualifiedEntityPattern> qualifiedEntityPatterns)
void	start()
void	stop()
void	stop(Runnable callback)
protected void	swap(javax.cache.Cache clone, Map<String,Set<Long>> isolatedSitesClone)

Methods inherited from class java.lang.Object

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

Field Detail

enabled

@Value(value="${precached.sparse.override.cache.enable:false}")
protected boolean enabled

maxElementsInMemory

@Value(value="${precached.sparse.override.max.elements.inmemory:5000}")
protected int maxElementsInMemory

refreshInterval

@Value(value="${precached.sparse.override.refresh.interval.millis:3600000}")
protected long refreshInterval

groomingEnabled

@Value(value="${precached.sparse.override.incremental.cache.grooming.enabled:true}")
protected boolean groomingEnabled

qualifiedEntityPatterns

protected List<SparseOverridePreCacheQualifiedEntityPattern> qualifiedEntityPatterns

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

handlers

protected List<org.broadleafcommerce.common.cache.OverridePreCacheInitializer> handlers

em

protected javax.persistence.EntityManager em

jcacheUtil

protected org.broadleafcommerce.common.extensibility.cache.JCacheUtil jcacheUtil

currentCache

protected javax.cache.Cache currentCache

sitesWithIsolatedValuesByType

protected Map<String,Set<Long>> sitesWithIsolatedValuesByType

cloneCount

protected int cloneCount

lock

protected ReadWriteLock lock

typeStatus

protected ConcurrentHashMap<String,Boolean> typeStatus

isStarted

protected boolean isStarted

timer

protected Timer timer

Constructor Detail

SparseOverridePreCacheServiceImpl

public SparseOverridePreCacheServiceImpl()

Method Detail

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

findElements

public List<org.broadleafcommerce.common.extension.StandardCacheItem> findElements(String... cacheKeys)

Specified by:

findElements in interface org.broadleafcommerce.common.cache.OverridePreCacheService

isActiveIsolatedSiteForType

public boolean isActiveIsolatedSiteForType(Long siteId,
                                           String entityType)

Specified by:

isActiveIsolatedSiteForType in interface org.broadleafcommerce.common.cache.OverridePreCacheService

isActiveForType

public boolean isActiveForType(String type)

Specified by:

isActiveForType in interface org.broadleafcommerce.common.cache.OverridePreCacheService

groomCacheBySiteOverride

public void groomCacheBySiteOverride(String entityType,
                                     Long cloneId,
                                     boolean isRemove)

Specified by:

groomCacheBySiteOverride in interface org.broadleafcommerce.common.cache.OverridePreCacheService

refreshCache

public void refreshCache()

Specified by:

refreshCache in interface org.broadleafcommerce.common.cache.OverridePreCacheService

groomCacheByTargetEntity

public void groomCacheByTargetEntity(String entityType,
                                     Serializable id)

Specified by:

groomCacheByTargetEntity in interface org.broadleafcommerce.common.cache.OverridePreCacheService

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getCurrentCache

public javax.cache.Cache getCurrentCache()

setCurrentCache

public void setCurrentCache(javax.cache.Cache currentCache)

applyToCache

protected void applyToCache(Class<?> type,
                            List results,
                            javax.cache.Cache cache,
                            boolean isRemove)

applyToCache

protected void applyToCache(Class<?> type,
                            List<Long> sitesWithIsolatedValues,
                            Map<String,Set<Long>> isolatedSiteCache)

getType

protected Class<?> getType(String entityType)

populateCache

protected void populateCache(javax.persistence.EntityManager em,
                             List<String> qualifiedTypes,
                             javax.cache.Cache clone)

populateCache

protected void populateCache(javax.persistence.EntityManager em,
                             List<String> staticQualifiedTypes,
                             Map<String,Set<Long>> isolatedSiteCache)

getFullCacheResults

protected List getFullCacheResults(String qualifiedType,
                                   Class<?> type,
                                   javax.persistence.EntityManager em)

getStandardSitesContainingIsolatedValues

protected List<Long> getStandardSitesContainingIsolatedValues(Class<?> type,
                                                              javax.persistence.EntityManager em)

swap

protected void swap(javax.cache.Cache clone,
                    Map<String,Set<Long>> isolatedSitesClone)

getStaticQualifiedTypes

protected List<String> getStaticQualifiedTypes(javax.persistence.EntityManager em)

getQualifiedTypes

protected List<String> getQualifiedTypes(javax.persistence.EntityManager em)

getQualifiedEntityPatterns

public List<SparseOverridePreCacheQualifiedEntityPattern> getQualifiedEntityPatterns()

setQualifiedEntityPatterns

public void setQualifiedEntityPatterns(List<SparseOverridePreCacheQualifiedEntityPattern> qualifiedEntityPatterns)

getHandlers

public List<org.broadleafcommerce.common.cache.OverridePreCacheInitializer> getHandlers()

setHandlers

public void setHandlers(List<org.broadleafcommerce.common.cache.OverridePreCacheInitializer> handlers)

isGroomingEnabled

public boolean isGroomingEnabled()

setGroomingEnabled

public void setGroomingEnabled(boolean groomingEnabled)