com.konakart.blif

Interface CacheMgrIf

All Known Implementing Classes:

CacheMgr

public interface CacheMgrIf

CacheMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
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
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
void	shutdown() Shutdown the Caches
void	startup() Start up the Caches
boolean	useEhcache() Use Ehcache?

Method Detail

startup

void startup()

Start up the Caches

shutdown

void shutdown()

Shutdown the Caches

get

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

Get an object from the specified cache with the specified key

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

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

Remove the object from the specified cache with the specified key

Parameters:

cacheName - name of the cache

key - key of the object to remove

put

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

Parameters:

cacheName - name of the cache

key - key of the object to put

value - value to put

flushProduct

void flushProduct(int productId)

Flush a single product from the caches

Parameters:

productId - the productId

flush

void flush(java.lang.String cacheName)

Flush/Clear the specified cache.

Parameters:

cacheName - the cacheName

useEhcache

boolean useEhcache()

Use Ehcache?

Returns:

true if we should use Ehcache

getCacheType

int getCacheType()

Get the Cache Type being used

Returns:

an integer indicating the cache type - either KKConstants.CACHETYPE_KONAKART or KKConstants.CACHETYPE_KONAKART

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the manager's configuration

Throws:

java.lang.Exception - an unexpected exception

processEvents

void processEvents()
            throws java.lang.Exception

Reads and executes the KKEvents

Throws:

java.lang.Exception - an unexpected exception

dumpCacheStatus

void dumpCacheStatus(java.lang.String cacheName)

Dump details of the named cache

Parameters:

cacheName - the cacheName

isCachingEnabled

boolean isCachingEnabled()

Is global caching enabled

Returns:

true if global caching is enabled

isCacheMgrStarted

boolean isCacheMgrStarted()

Is CacheMgr started up?

Returns:

true if CacheMgr is initialised and ready to be used