ColdBox Platform Version 3.7.0

coldbox.system.cache
Class AbstractCacheBoxProvider

WEB-INF.cftags.component
        extended by coldbox.system.cache.AbstractCacheBoxProvider
Direct Known Subclasses:
CacheBoxProvider , MockProvider

public abstract class AbstractCacheBoxProvider
extends WEB-INF.cftags.component

An abstract CacheBox Provider with basic/boring functionality built


Constructor Summary
init()
          Simple Constructor
 
Method Summary
 void clearStatistics()
          Clear the cache statistics
 any<CacheFactory> getCacheFactory()
          Get the cache factory reference this cache provider belongs to
 any getCacheID()
          The unique cache ID number
 any<struct> getConfiguration()
          Get the structure of configuration parameters for the cache
 any getEventManager()
          Get this cache managers event listner manager
 any getMemento()
          Return the cache provider's instance memento
 any getName()
          Get the name of this cache
 any<ICacheStats> getStats()
          Get the cache statistics object as coldbox
private any getUtil()
          Create and return a util object
 any<boolean> isEnabled()
          Returns a flag indicating if the cache is ready for operation
 any<boolean> isReportingEnabled()
          Returns a flag indicating if the cache has reporting enabled
 void setCacheFactory(any<CacheFactory> cacheFactory)
          Set the cache factory reference for this cache
 void setConfiguration(any configuration)
          Override the entire configuration structure for this cache
 void setEventManager(any eventManager)
          Set the event manager for this cache
 void setName(any name)
          Set the cache name
private void statusCheck()
          Check if the cache is operational, else throw exception
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
Simple Constructor

Method Detail

clearStatistics

public void clearStatistics()
Clear the cache statistics


getCacheFactory

public any<CacheFactory> getCacheFactory()
Get the cache factory reference this cache provider belongs to


getCacheID

public any getCacheID()
The unique cache ID number


getConfiguration

public any<struct> getConfiguration()
Get the structure of configuration parameters for the cache


getEventManager

public any getEventManager()
Get this cache managers event listner manager


getMemento

public any getMemento()
Return the cache provider's instance memento


getName

public any getName()
Get the name of this cache


getStats

public any<ICacheStats> getStats()
Get the cache statistics object as coldbox.system.cache.util.ICacheStats


getUtil

private any getUtil()
Create and return a util object


isEnabled

public any<boolean> isEnabled()
Returns a flag indicating if the cache is ready for operation


isReportingEnabled

public any<boolean> isReportingEnabled()
Returns a flag indicating if the cache has reporting enabled


setCacheFactory

public void setCacheFactory(any<CacheFactory> cacheFactory)
Set the cache factory reference for this cache

Parameters:
cacheFactory

setConfiguration

public void setConfiguration(any configuration)
Override the entire configuration structure for this cache

Parameters:
configuration - The configuration structure

setEventManager

public void setEventManager(any eventManager)
Set the event manager for this cache

Parameters:
eventManager - The event manager class

setName

public void setName(any name)
Set the cache name

Parameters:
name - The cache name

statusCheck

private void statusCheck()
Check if the cache is operational, else throw exception


ColdBox Platform Version 3.7.0