com.konakart.bl

Class CacheMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.CacheMgr

All Implemented Interfaces:

CacheMgrIf

public class CacheMgr
extends BaseMgr
implements CacheMgrIf

Cache Manager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CacheMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
static int	cacheType Cache Type - default is KonaKart
protected static java.lang.String	KKProdCacheQMutex KK Prod Cache Queue Mutex
protected static java.util.LinkedList<java.lang.String>	kkProdCacheQueue Queue of lookup key entries in the KonaKart Product Cache
protected static java.util.Set<java.lang.String>	kkProdCacheSet Set of lookup key entries in the KonaKart Product Cache
protected static java.lang.String	KKSizeCheckMutex KK Cache Size Check Mutex
protected static int	lastEventProcessed Index of Last Event Processed
protected static java.lang.String	lastIndexMutex lastIndexMutex
static boolean	lastIndexSet Start-up flag for setting lastIndex
protected static org.apache.commons.logging.Log	log Log
protected static java.lang.String	mutex Mutex
static boolean	started Start-up flag
protected static java.util.Map<java.lang.String,CacheMgr.StaticData>	staticDataHM Hash Map that contains the static data
protected static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	staticKKCaches A Map containing the a Map for each cache

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
CacheMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	checkKonaKartCacheSize(java.lang.String cacheName, java.util.Map<java.lang.String,java.lang.Object> kkCache) Ensure the KonaKart Product Cache is not bigger than the maximum defined size
void	dumpCacheStatus(java.lang.String cacheName) Dump details of the named cache
void	flush(java.lang.String cacheName) Flush/Clear the specified cache.
void	flushProduct(int productId) Flush a single product from the caches
java.lang.Object	get(java.lang.String cacheName, java.lang.String key) Get an object from the specified cache with the specified key
int	getCacheType() Get the Cache Type being used
static int	getLastEventProcessed()
boolean	isCacheMgrStarted() Is CacheMgr started up?
boolean	isCachingEnabled() Is global caching enabled
void	processEvents() Reads and executes the KKEvents
void	put(java.lang.String cacheName, java.lang.String key, java.lang.Object value) Put an object into the specified cache with the specified key
void	refreshConfigs() Refresh the manager's configuration.
void	remove(java.lang.String cacheName, java.lang.String key) Remove the object from the specified cache with the specified key
static void	setCachingEnabled(boolean cachingEnabled)
static void	setLastEventProcessed(int lastEventProcessed)
void	setLastIndex() If the lastEventProcessed Index is -1 (hasn't yet been set) we set it to the highest index in the events table.
void	shutdown() Shutdown the Caches
void	startup() Start up the Caches
boolean	useEhcache() Use Ehcache?

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

Log

staticKKCaches

protected static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> staticKKCaches

A Map containing the a Map for each cache

cacheType

public static int cacheType

Cache Type - default is KonaKart

started

public static boolean started

Start-up flag

lastIndexSet

public static boolean lastIndexSet

Start-up flag for setting lastIndex

mutex

protected static java.lang.String mutex

Mutex

lastIndexMutex

protected static java.lang.String lastIndexMutex

lastIndexMutex

KKSizeCheckMutex

protected static java.lang.String KKSizeCheckMutex

KK Cache Size Check Mutex

KKProdCacheQMutex

protected static java.lang.String KKProdCacheQMutex

KK Prod Cache Queue Mutex

lastEventProcessed

protected static int lastEventProcessed

Index of Last Event Processed

staticDataHM

protected static java.util.Map<java.lang.String,CacheMgr.StaticData> staticDataHM

Hash Map that contains the static data

kkProdCacheQueue

protected static java.util.LinkedList<java.lang.String> kkProdCacheQueue

Queue of lookup key entries in the KonaKart Product Cache

kkProdCacheSet

protected static java.util.Set<java.lang.String> kkProdCacheSet

Set of lookup key entries in the KonaKart Product Cache

Constructor Detail

CacheMgr

public CacheMgr(KKEngIf eng)
         throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

startup

public void startup()

Description copied from interface: CacheMgrIf

Start up the Caches

Specified by:

startup in interface CacheMgrIf

useEhcache

public boolean useEhcache()

Description copied from interface: CacheMgrIf

Use Ehcache?

Specified by:

useEhcache in interface CacheMgrIf

Returns:

true if we should use Ehcache

shutdown

public void shutdown()

Description copied from interface: CacheMgrIf

Shutdown the Caches

Specified by:

shutdown in interface CacheMgrIf

get

public java.lang.Object get(java.lang.String cacheName,
                            java.lang.String key)

Description copied from interface: CacheMgrIf

Get an object from the specified cache with the specified key

Specified by:

get in interface CacheMgrIf

Parameters:

cacheName - name of the cache

key - key of the object to get

Returns:

the object associated with the specified key in the specified cache

remove

public void remove(java.lang.String cacheName,
                   java.lang.String key)

Description copied from interface: CacheMgrIf

Remove the object from the specified cache with the specified key

Specified by:

remove in interface CacheMgrIf

Parameters:

cacheName - name of the cache

key - key of the object to remove

put

public void put(java.lang.String cacheName,
                java.lang.String key,
                java.lang.Object value)

Description copied from interface: CacheMgrIf

Put an object into the specified cache with the specified key

Specified by:

put in interface CacheMgrIf

Parameters:

cacheName - name of the cache

key - key of the object to put

value - value to put

checkKonaKartCacheSize

protected void checkKonaKartCacheSize(java.lang.String cacheName,
                                      java.util.Map<java.lang.String,java.lang.Object> kkCache)

Ensure the KonaKart Product Cache is not bigger than the maximum defined size

Parameters:

cacheName - the cacheName

kkCache - the kkCache

flush

public void flush(java.lang.String cacheName)

Description copied from interface: CacheMgrIf

Flush/Clear the specified cache.

Specified by:

flush in interface CacheMgrIf

Parameters:

cacheName - the cacheName

flushProduct

public void flushProduct(int productId)

Description copied from interface: CacheMgrIf

Flush a single product from the caches

Specified by:

flushProduct in interface CacheMgrIf

Parameters:

productId - the productId

processEvents

public void processEvents()
                   throws java.lang.Exception

Reads and executes the KKEvents

Specified by:

processEvents in interface CacheMgrIf

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the manager's configuration. We clear the caches. Note that this could override the Ehcache definition for the respective caches.

Specified by:

refreshConfigs in interface CacheMgrIf

Throws:

java.lang.Exception - an unexpected exception

dumpCacheStatus

public void dumpCacheStatus(java.lang.String cacheName)

Dump details of the named cache

Specified by:

dumpCacheStatus in interface CacheMgrIf

Parameters:

cacheName - the cacheName

getCacheType

public int getCacheType()

Description copied from interface: CacheMgrIf

Get the Cache Type being used

Specified by:

getCacheType in interface CacheMgrIf

Returns:

the cacheType

setLastIndex

public void setLastIndex()

If the lastEventProcessed Index is -1 (hasn't yet been set) we set it to the highest index in the events table. If there are no events we set it to 0;

getLastEventProcessed

public static int getLastEventProcessed()

Returns:

the lastEventProcessed

setLastEventProcessed

public static void setLastEventProcessed(int lastEventProcessed)

Parameters:

lastEventProcessed - the lastEventProcessed to set

isCachingEnabled

public boolean isCachingEnabled()

Description copied from interface: CacheMgrIf

Is global caching enabled

Specified by:

isCachingEnabled in interface CacheMgrIf

Returns:

the cachingEnabled

setCachingEnabled

public static void setCachingEnabled(boolean cachingEnabled)

Parameters:

cachingEnabled - the cachingEnabled to set

isCacheMgrStarted

public boolean isCacheMgrStarted()

Description copied from interface: CacheMgrIf

Is CacheMgr started up?

Specified by:

isCacheMgrStarted in interface CacheMgrIf

Returns:

true if CacheMgr is initialised and ready to be used