com.broadleafcommerce.jobsevents.service.consumer

Class CacheInvalidationHelperImpl

java.lang.Object

com.broadleafcommerce.jobsevents.service.consumer.CacheInvalidationHelperImpl

All Implemented Interfaces:

CacheInvalidationHelper

@Service(value="blCacheInvalidationHelper")
public class CacheInvalidationHelperImpl
extends Object
implements CacheInvalidationHelper

Author:

Jeff Fischer, Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.persistence.EntityConfiguration	entityConfiguration
protected org.broadleafcommerce.common.util.dao.DynamicDaoHelper	helper
protected org.broadleafcommerce.common.service.PersistenceService	persistenceService

Constructor Summary

Constructors

Constructor and Description
CacheInvalidationHelperImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addEventDetail(SystemEvent event, String name, String value)
SystemEvent	constructEvent(String originalItemId, String entityType, String propertyVal, Long processStatusMarker, String region, Long targetSandBox, Long currentProfile, Long currentCatalog, EventWorkerType workerType) Create a cache invalidation event
SystemEvent	constructRegionEvent(Long processStatusMarker, String region, EventWorkerType workerType) Create a cache invalidation event to invalidate an entire cache region
Field	getField(Class<?> clazz, String fieldName)
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.

Methods inherited from class java.lang.Object

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

Field Detail

entityConfiguration

protected org.broadleafcommerce.common.persistence.EntityConfiguration entityConfiguration

persistenceService

protected org.broadleafcommerce.common.service.PersistenceService persistenceService

helper

protected org.broadleafcommerce.common.util.dao.DynamicDaoHelper helper

Constructor Detail

CacheInvalidationHelperImpl

public CacheInvalidationHelperImpl()

Method Detail

constructEvent

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

Description copied from interface: CacheInvalidationHelper

Create a cache invalidation event

Specified by:

constructEvent in interface CacheInvalidationHelper

Returns:

addEventDetail

protected void addEventDetail(SystemEvent event,
                              String name,
                              String value)

constructRegionEvent

public SystemEvent constructRegionEvent(Long processStatusMarker,
                                        String region,
                                        EventWorkerType workerType)

Description copied from interface: CacheInvalidationHelper

Create a cache invalidation event to invalidate an entire cache region

Specified by:

constructRegionEvent in interface CacheInvalidationHelper

Returns:

getInvalidationRegions

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

Description copied from interface: CacheInvalidationHelper

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 CacheInvalidationHelper.getTypeRegions(Class[])

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

Specified by:

getInvalidationRegions in interface CacheInvalidationHelper

See Also:

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

getPropertyRegion

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

Description copied from interface: CacheInvalidationHelper

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

Specified by:

getPropertyRegion in interface CacheInvalidationHelper

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

getTypeRegions

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

Description copied from interface: CacheInvalidationHelper

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

Specified by:

getTypeRegions in interface CacheInvalidationHelper

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

getField

public Field getField(Class<?> clazz,
                      String fieldName)
               throws IllegalStateException

Throws:

IllegalStateException