com.broadleafcommerce.jobsevents.service.consumer

Interface CacheInvalidationHelper

All Known Implementing Classes:

CacheInvalidationHelperImpl

public interface CacheInvalidationHelper

Helper methods for working with cache invalidation events

Author:

Jeff Fischer, Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
SystemEvent	constructEvent(String originalItemId, String entityType, String propertyVal, Long processMarker, String region, Long targetSandBox, Long currentProfile, Long currentCatalog, EventWorkerType workerType) Create a cache invalidation event
SystemEvent	constructRegionEvent(Long processMarker, String region, EventWorkerType workerType) Create a cache invalidation event to invalidate an entire cache region
List<EntityCacheRegion>	getInvalidationRegions(String property, Class<?>[] entityClass) If the given property is not empty or and the given property is annotated with @Cache this will return the result of #getPropertyRegion(property, Class[]).
EntityCacheRegion	getPropertyRegion(String property, Class<?>[] entityClass) Inspects the property for the given entityClass to look for an @Cache annotation marking the region in which this property is cached
List<EntityCacheRegion>	getTypeRegions(Class<?>[] entityClass) Walks up the hierarchies of the given classes looking @Cache annotation values.

Method Detail

constructEvent

SystemEvent constructEvent(String originalItemId,
                           String entityType,
                           String propertyVal,
                           Long processMarker,
                           String region,
                           Long targetSandBox,
                           Long currentProfile,
                           Long currentCatalog,
                           EventWorkerType workerType)

Create a cache invalidation event

Parameters:

originalItemId -

entityType -

propertyVal -

processMarker -

region -

targetSandBox -

currentProfile -

currentCatalog -

workerType -

Returns:

getInvalidationRegions

List<EntityCacheRegion> getInvalidationRegions(@Nullable
                                               String property,
                                               Class<?>[] entityClass)

If the given property is not empty or and the given property is annotated with @Cache this will return the result of #getPropertyRegion(property, Class[]). In this case the returned list will be a single-element

If the given property is empty or is not annotated with @Cache then this will return the result of getTypeRegions(Class[])

If both the given property and the list of classes are marked with @Cache then this returns an empty list

Throws:

IllegalArgumentException - if the property cannot be found on any class within entityClass

See Also:

#getPropertyRegion(String, Class[])}, #getTypeRegions(Class[])}

getTypeRegions

List<EntityCacheRegion> getTypeRegions(Class<?>[] entityClass)

Walks up the hierarchies of the given classes looking @Cache annotation values. For each one that is found, a list is built up of the region specified in the @Cache annotation and which fully-qualified type that it was found on. This is used to construct the eviction key for Hibernate.

This is designed to work in the following scenarios:

1. Broadleaf has an entity SkuImpl that is annotated with @Cache("blProducts")
2. There is an extension of SkuImpl called ExtendedSku
3. ExtendedSku does not have an @Cache annotation
4. Hibernate builds a cache key with the name SkuImpl inside of the blProducts cache as opposed to using the extended type name

1. Broadleaf has an entity SkuImpl that is annotated with @Cache("blProducts")
2. There is an extension of SkuImpl called ExtendedSku
3. ExtendedSku is annotated with @Cache("otherEntityCache")
4. Hibernate caches the name SkuImpl inside of the blProducts cache and caches the name ExtendedSku inside of the otherEntityCache cache

Parameters:

entityClass -

Returns:

a list of mappings to which fully-qualified entity type is within which cache region. If no entities in the hierarchy are annotated with @Cache this returns an empty list

getPropertyRegion

EntityCacheRegion getPropertyRegion(@Nullable
                                    String property,
                                    Class<?>[] entityClass)

Inspects the property for the given entityClass to look for an @Cache annotation marking the region in which this property is cached

Parameters:

property -

entityClass -

Returns:

the mapping of property cache region and which fully-qualified class name the property is apart of. If property is not cacheable then this returns null

Throws:

IllegalArgumentException - if the given property cannot be found on any of entityClass

constructRegionEvent

SystemEvent constructRegionEvent(Long processMarker,
                                 String region,
                                 EventWorkerType workerType)

Create a cache invalidation event to invalidate an entire cache region

Parameters:

processMarker -

region -

workerType -

Returns: