com.broadleafcommerce.jobsevents.cache

Class AbstractClusterCache

java.lang.Object

com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

com.broadleafcommerce.jobsevents.cache.AbstractClusterCache

All Implemented Interfaces:

EntityManagerFactoryAwareSystemEventConsumer, SystemEventConsumer, org.springframework.core.Ordered

public abstract class AbstractClusterCache
extends AbstractSystemEventConsumer

A lightweight cluster-aware cache mechanism that leverages JCache. Cluster cache operations are engaged via regular Broadleaf events.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.cache.Cache<String,KeyedItem>	cache
protected String	CACHE_UID
protected org.broadleafcommerce.common.extensibility.cache.JCacheUtil	jCacheUtil
protected SystemEventSender	systemEventSender

Fields inherited from class com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

entityManagerFactory

Fields inherited from interface com.broadleafcommerce.jobsevents.service.SystemEventConsumer

DEFAULT_PRECEDENCE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractClusterCache()

Method Summary

Modifier and Type	Method and Description
void	addCacheMemberAndNotifyCluster(KeyedItem cacheMember)
void	addLocalCacheMemberOnly(KeyedItem cacheMember)
protected void	addToCache(KeyedItem cacheMember)
void	clearAndNotifyCluster()
void	clearLocalOnly()
protected abstract KeyedItem	constructItem(Collection<SystemEventDetail> details)
void	consumeEvent(SystemEvent event)
protected SystemEvent	createEvent(EventOperationType operation, KeyedItem cacheMember)
protected javax.cache.Cache<String,KeyedItem>	getCache()
protected abstract String	getCacheRegion()
protected abstract Collection<SystemEventDetail>	getClusterCacheEventDetails(KeyedItem cacheMember)
String	getEventType()
void	printCacheContents()
protected void	removeAll()
void	removeCacheMemberAndNotifyCluster(KeyedItem cacheMember)
protected void	removeFromCache(KeyedItem cacheMember)
void	removeLocalCacheMemberOnly(KeyedItem cacheMember)

Methods inherited from class com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

getEntityManagerFactory, getOrder, setEntityManagerFactory

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_UID

protected final String CACHE_UID

systemEventSender

protected SystemEventSender systemEventSender

jCacheUtil

protected org.broadleafcommerce.common.extensibility.cache.JCacheUtil jCacheUtil

cache

protected javax.cache.Cache<String,KeyedItem> cache

Constructor Detail

AbstractClusterCache

public AbstractClusterCache()

Method Detail

addCacheMemberAndNotifyCluster

public void addCacheMemberAndNotifyCluster(KeyedItem cacheMember)

addLocalCacheMemberOnly

public void addLocalCacheMemberOnly(KeyedItem cacheMember)

removeCacheMemberAndNotifyCluster

public void removeCacheMemberAndNotifyCluster(KeyedItem cacheMember)

removeLocalCacheMemberOnly

public void removeLocalCacheMemberOnly(KeyedItem cacheMember)

clearAndNotifyCluster

public void clearAndNotifyCluster()

clearLocalOnly

public void clearLocalOnly()

addToCache

protected void addToCache(KeyedItem cacheMember)

removeFromCache

protected void removeFromCache(KeyedItem cacheMember)

removeAll

protected void removeAll()

getCache

protected javax.cache.Cache<String,KeyedItem> getCache()

createEvent

protected SystemEvent createEvent(EventOperationType operation,
                                  KeyedItem cacheMember)

consumeEvent

public void consumeEvent(SystemEvent event)

printCacheContents

public void printCacheContents()

getEventType

public String getEventType()

getCacheRegion

protected abstract String getCacheRegion()

getClusterCacheEventDetails

protected abstract Collection<SystemEventDetail> getClusterCacheEventDetails(KeyedItem cacheMember)

constructItem

protected abstract KeyedItem constructItem(Collection<SystemEventDetail> details)