|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.cache.AbstractCacheBoxProvider
public abstract class AbstractCacheBoxProvider
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 |
---|
None
|
Constructor Detail |
---|
public init()
Method Detail |
---|
public void clearStatistics()
public any<CacheFactory> getCacheFactory()
public any getCacheID()
public any<struct> getConfiguration()
public any getEventManager()
public any getMemento()
public any getName()
public any<ICacheStats> getStats()
private any getUtil()
public any<boolean> isEnabled()
public any<boolean> isReportingEnabled()
public void setCacheFactory(any<CacheFactory> cacheFactory)
cacheFactory
public void setConfiguration(any configuration)
configuration
- The configuration structurepublic void setEventManager(any eventManager)
eventManager
- The event manager classpublic void setName(any name)
name
- The cache nameprivate void statusCheck()
|
ColdBox Platform v3.8.0 | ||||
FRAMES |