org.broadleafcommerce.common.cache

Interface OverridePreCacheService

All Known Implementing Classes:

DefaultOverridePreCacheServiceImpl

public interface OverridePreCacheService

Describes a service capable of maintaining a cache of standard site level overrides. This cache spans multiple entity types. This is a multitenant concept. An override declaration and the actual overridden entity are generally two different things. This cache is responsible for reviewing a list of overrides declarations and caching the referenced overridden entities.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
List<StandardCacheItem>	findElements(String... cacheKeys) Find any cached items matching the passed keys
void	groomCacheBySiteOverride(String entityType, Long cloneId, boolean isRemove) Add or remove from the cache based on an override declaration.
void	groomCacheByTargetEntity(String entityType, Serializable id) Update an overridden entity value in the cache
boolean	isActiveForType(String type) Whether or not the cache is active for the specified type
boolean	isActiveIsolatedSiteForType(Long siteId, String entityType) Assuming the passed in site is a standard site, determine whether or not the standard site has any isolated values (i.e.
void	refreshCache() Refresh the entire cache structure.

Method Detail

findElements

List<StandardCacheItem> findElements(String... cacheKeys)

Find any cached items matching the passed keys

Parameters:

cacheKeys - the keys to check

Returns:

isActiveIsolatedSiteForType

boolean isActiveIsolatedSiteForType(Long siteId,
                                    String entityType)

Assuming the passed in site is a standard site, determine whether or not the standard site has any isolated values (i.e. not inherited) for the given type. This information is generally useful when making optimized query determinations for whether or not the standard site should be included in the query.

Parameters:

siteId -

entityType -

Returns:

isActiveForType

boolean isActiveForType(String type)

Whether or not the cache is active for the specified type

Parameters:

type - the entity type to check

Returns:

groomCacheBySiteOverride

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

Add or remove from the cache based on an override declaration.

Parameters:

entityType -

cloneId -

isRemove -

groomCacheByTargetEntity

void groomCacheByTargetEntity(String entityType,
                              Serializable id)

Update an overridden entity value in the cache

Parameters:

entityType -

id -

refreshCache

void refreshCache()

Refresh the entire cache structure. Presumably, this will clear and rebuild the structure.