com.broadleafcommerce.tenant.service.extension

Class MultiTenantCatalogCacheExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.AbstractCatalogCacheServiceExtensionHandler

com.broadleafcommerce.tenant.service.extension.MultiTenantCatalogCacheExtensionHandler

All Implemented Interfaces:

com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.CatalogCacheServiceExtensionHandler, AssignedCatalogStateChangeListener, org.broadleafcommerce.common.extension.ExtensionHandler

@Component(value="blMultitTenantCatalogCacheExtensionHandler")
public class MultiTenantCatalogCacheExtensionHandler
extends com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.AbstractCatalogCacheServiceExtensionHandler
implements AssignedCatalogStateChangeListener

Ensures that the list of catalogs contributes to the cache key of the category and product URLs

Author:

Phillip Verheyden (phillipuniverse), Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alternateCacheFetch The default fetch behavior is to fetch a catalog product or category once per site, even if that product or category are the same across multiple sites.
protected int	catalogRequestCacheMaxCount
protected com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.CatalogCacheServiceExtensionManager	extensionManager
protected Map<String,CacheKeyMaps>	keysByCache
protected static org.apache.commons.logging.Log	LOG
static int	STATE_CHANGE_LISTENER_ORDER

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
MultiTenantCatalogCacheExtensionHandler()

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addEntityToCache(Object entity, String basicCacheKey, javax.cache.Cache cache)
protected String	buildCatalogCacheKey(Long catalog, String basicCacheKey)
protected String	buildSiteCacheKey(Long site, String basicCacheKey)
int	getAssignedCatalogStateChangeListenerOrder()
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getEntityFromCache(String basicCacheKey, javax.cache.Cache cache, org.broadleafcommerce.common.extension.ExtensionResultHolder result)
void	init()
void	notifyAssignedCatalogStateChange(org.broadleafcommerce.common.site.domain.SiteCatalogXref xref)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	removeEntityFromCache(String basicCacheKey, Object entity, javax.cache.Cache cache)

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

LOG

protected static final org.apache.commons.logging.Log LOG

STATE_CHANGE_LISTENER_ORDER

public static final int STATE_CHANGE_LISTENER_ORDER

See Also:

Constant Field Values

catalogRequestCacheMaxCount

@Value(value="${catalog.requesturi.cache.max.count:25000}")
protected int catalogRequestCacheMaxCount

extensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.CatalogCacheServiceExtensionManager extensionManager

alternateCacheFetch

@Value(value="${catalog.requesturi.cache.alternative.fetch:false}")
protected boolean alternateCacheFetch

The default fetch behavior is to fetch a catalog product or category once per site, even if that product or category are the same across multiple sites. This provides the most efficient fetch behavior when there are few sites. However, this property can be set to true to cause each fetch to check what catalogs are available to the current context site, which provides an opportunity to avoid re-fetching the same product or category, at the cost of iterating through assigned catalogs to make the determination. Therefore, it is only suggested to set this property to true when you have many sites with a small number of catalogs assigned to each site. The default is false.

keysByCache

protected Map<String,CacheKeyMaps> keysByCache

Constructor Detail

MultiTenantCatalogCacheExtensionHandler

public MultiTenantCatalogCacheExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

addEntityToCache

public org.broadleafcommerce.common.extension.ExtensionResultStatusType addEntityToCache(Object entity,
                                                                                         String basicCacheKey,
                                                                                         javax.cache.Cache cache)

Specified by:

addEntityToCache in interface com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.CatalogCacheServiceExtensionHandler

Overrides:

addEntityToCache in class com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.AbstractCatalogCacheServiceExtensionHandler

getEntityFromCache

public org.broadleafcommerce.common.extension.ExtensionResultStatusType getEntityFromCache(String basicCacheKey,
                                                                                           javax.cache.Cache cache,
                                                                                           org.broadleafcommerce.common.extension.ExtensionResultHolder result)

Specified by:

getEntityFromCache in interface com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.CatalogCacheServiceExtensionHandler

Overrides:

getEntityFromCache in class com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.AbstractCatalogCacheServiceExtensionHandler

removeEntityFromCache

public org.broadleafcommerce.common.extension.ExtensionResultStatusType removeEntityFromCache(String basicCacheKey,
                                                                                              Object entity,
                                                                                              javax.cache.Cache cache)

Specified by:

removeEntityFromCache in interface com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.CatalogCacheServiceExtensionHandler

Overrides:

removeEntityFromCache in class com.broadleafcommerce.enterprise.common.extension.enterprise.catalog.AbstractCatalogCacheServiceExtensionHandler

notifyAssignedCatalogStateChange

public void notifyAssignedCatalogStateChange(org.broadleafcommerce.common.site.domain.SiteCatalogXref xref)

Specified by:

notifyAssignedCatalogStateChange in interface AssignedCatalogStateChangeListener

getAssignedCatalogStateChangeListenerOrder

public int getAssignedCatalogStateChangeListenerOrder()

Specified by:

getAssignedCatalogStateChangeListenerOrder in interface AssignedCatalogStateChangeListener

buildCatalogCacheKey

protected String buildCatalogCacheKey(Long catalog,
                                      String basicCacheKey)

buildSiteCacheKey

protected String buildSiteCacheKey(Long site,
                                   String basicCacheKey)