com.broadleafcommerce.enterprise.workflow.admin.service.event

Interface CacheInvalidationProducer

All Superinterfaces:

CommonCacheInvalidationProducer

All Known Implementing Classes:

CacheInvalidationProducerImpl

public interface CacheInvalidationProducer
extends CommonCacheInvalidationProducer

Responsible for invalidating any production cache values that have been changed as the result of a scheduled deployment.

Author:

Jeff Fischer

See Also:

ScheduledDeploySystemEventConsumer

Method Summary

Modifier and Type	Method and Description
void	finalizeEvents(Long processStatusMarker) Some implementations, including the default implementation CacheInvalidationProducerImpl, will create events for another asynchronous process to consume for the actual invalidation.
void	invalidateCache(Long processStatusMarker, List<WorkflowSandBoxItem> sandBoxItems, List<String> maxedRegions, Long sourceSandBox, Long targetSandBox, boolean includeAdditionalProducers) Invalidate any production cache for the specified list of deployed items.
void	invalidateCacheForNonSandboxableItems(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Methods inherited from interface com.broadleafcommerce.enterprise.workflow.service.event.CommonCacheInvalidationProducer

sendSiteOverrideCacheEvictEvent

Method Detail

invalidateCache

void invalidateCache(Long processStatusMarker,
                     List<WorkflowSandBoxItem> sandBoxItems,
                     List<String> maxedRegions,
                     Long sourceSandBox,
                     Long targetSandBox,
                     boolean includeAdditionalProducers)

Invalidate any production cache for the specified list of deployed items. This is generally ORM level 2 cache, but can also be other custom caches.

Parameters:

processStatusMarker - unique marker id created as part of the original deployment/promote PromotionStrategy.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean)

sandBoxItems - the deployed items for which cache invalidation is required

maxedRegions - any cache regions for which a threshold of individual cache invalidations has been exceeded. When reached, individual cached invalidations are no longer created, but instead, the whole cache region is evicted. Several region max values are already defined in common.properties (i.e. blProducts.cache.region.evict.threshold). Additional max values can be defined using the format [cache region name].cache.region.evict.threshold = [max value].

sourceSandBox - the sandbox from which the original deployment took place

targetSandBox - the production sandbox (should generally be null)

includeAdditionalProducers -

invalidateCacheForNonSandboxableItems

void invalidateCacheForNonSandboxableItems(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Parameters:

persistencePackage -

finalizeEvents

void finalizeEvents(Long processStatusMarker)

Some implementations, including the default implementation CacheInvalidationProducerImpl, will create events for another asynchronous process to consume for the actual invalidation. This method provides a hook point to enable those events so that they're ready for consumption.

Parameters:

processStatusMarker - unique marker id created as part of the original deployment/promote PromotionStrategy.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean)