|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.cache.providers.CFProvider
public class CFProvider
******************************************************************************* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Author: Luis Majano Description: This CacheBox provider communicates with the built in caches in the Adobe ColdFusion Engine.
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
clear(any objectKey)
clear an element from cache |
void |
clearAll()
clear all elements from cache |
void |
clearByKeySnippet(any keySnippet, [any regex='false'], [any async='false'])
Clear by key snippet |
any |
clearQuiet(any objectKey)
clear with no stats |
void |
clearStatistics()
clear the cache stats |
void |
configure()
configure the cache for operation |
void |
expireAll()
not implemented by cache |
void |
expireObject(any objectKey)
not implemented by cache |
any |
get(any objectKey)
get an item from cache |
any |
getCacheFactory()
get the associated cache factory |
any |
getCachedObjectMetadata(any objectKey)
get an object's cached metadata |
any |
getConfiguration()
get the cache configuration structure |
any |
getEventManager()
get the event manager |
any |
getKeys()
get all the keys in this provider |
any |
getName()
get the cache name |
any |
getObjectStore()
Returns the ehCache storage session according to configured cache name |
any |
getOrSet(any objectKey, any produce, [any timeout='0'], [any lastAccessTimeout='0'], [any extra='[runtime expression]'])
Tries to get an object from the cache, if not found, it calls the 'produce' closure to produce the data and cache it |
any |
getQuiet(any objectKey)
get an item silently from cache, no stats advised |
any |
getSize()
get cache size |
any |
getStats()
|
any |
getStoreMetadataKeyMap()
Get a key lookup structure where cachebox can build the report on |
any |
getStoreMetadataReport()
get the cache's metadata report |
any |
isClusterCoherent()
|
any |
isEnabled()
|
any |
isExpired(any objectKey)
Not implemented by this cache |
any |
isNodeCoherent()
|
any |
isReportingEnabled()
|
any |
isTerracotaClustered()
|
any |
lookup(any objectKey)
check if object in cache |
any |
lookupQuiet(any objectKey)
check if object in cache with no stats |
void |
reap()
Not implemented, let ehCache due its thang! |
any |
set(any objectKey, any object, [any timeout='0'], [any lastAccessTimeout='0'], [any extra])
set an object in cache |
void |
setCacheFactory(any cacheFactory)
set the associated cache factory |
void |
setConfiguration(any configuration)
set the cache configuration structure |
void |
setEventManager(any EventManager)
set the event manager |
void |
setName(any name)
set the cache name |
any |
setQuiet(any objectKey, any object, [any timeout='0'], [any lastAccessTimeout='0'], [any extra])
set an object in cache with no stats |
void |
shutdown()
shutdown the cache |
private void |
validateConfiguration()
Validate the configuration |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Method Detail |
---|
public any clear(any objectKey)
clear
in interface
ICacheProvider
objectKey
public void clearAll()
clearAll
in interface
ICacheProvider
public void clearByKeySnippet(any keySnippet, [any regex='false'], [any async='false'])
keySnippet
regex
async
public any clearQuiet(any objectKey)
clearQuiet
in interface
ICacheProvider
objectKey
public void clearStatistics()
clearStatistics
in interface
ICacheProvider
public void configure()
configure
in interface
ICacheProvider
public void expireAll()
expireAll
in interface
ICacheProvider
public void expireObject(any objectKey)
expireObject
in interface
ICacheProvider
objectKey
public any get(any objectKey)
get
in interface
ICacheProvider
objectKey
public any getCacheFactory()
getCacheFactory
in interface
ICacheProvider
public any getCachedObjectMetadata(any objectKey)
getCachedObjectMetadata
in interface
ICacheProvider
objectKey
public any getConfiguration()
getConfiguration
in interface
ICacheProvider
public any getEventManager()
getEventManager
in interface
ICacheProvider
public any getKeys()
getKeys
in interface
ICacheProvider
public any getName()
getName
in interface
ICacheProvider
public any getObjectStore()
getObjectStore
in interface
ICacheProvider
public any getOrSet(any objectKey, any produce, [any timeout='0'], [any lastAccessTimeout='0'], [any extra='[runtime expression]'])
objectKey
produce
timeout
lastAccessTimeout
extra
public any getQuiet(any objectKey)
getQuiet
in interface
ICacheProvider
objectKey
public any getSize()
getSize
in interface
ICacheProvider
public any getStats()
getStats
in interface
ICacheProvider
public any getStoreMetadataKeyMap()
getStoreMetadataKeyMap
in interface
ICacheProvider
public any getStoreMetadataReport()
getStoreMetadataReport
in interface
ICacheProvider
public any isClusterCoherent()
public any isEnabled()
isEnabled
in interface
ICacheProvider
public any isExpired(any objectKey)
isExpired
in interface
ICacheProvider
objectKey
public any isNodeCoherent()
public any isReportingEnabled()
isReportingEnabled
in interface
ICacheProvider
public any isTerracotaClustered()
public any lookup(any objectKey)
lookup
in interface
ICacheProvider
objectKey
public any lookupQuiet(any objectKey)
lookupQuiet
in interface
ICacheProvider
objectKey
public void reap()
reap
in interface
ICacheProvider
public any set(any objectKey, any object, [any timeout='0'], [any lastAccessTimeout='0'], [any extra])
set
in interface
ICacheProvider
objectKey
object
timeout
lastAccessTimeout
extra
public void setCacheFactory(any cacheFactory)
setCacheFactory
in interface
ICacheProvider
cacheFactory
public void setConfiguration(any configuration)
setConfiguration
in interface
ICacheProvider
configuration
public void setEventManager(any EventManager)
setEventManager
in interface
ICacheProvider
EventManager
public void setName(any name)
setName
in interface
ICacheProvider
name
public any setQuiet(any objectKey, any object, [any timeout='0'], [any lastAccessTimeout='0'], [any extra])
setQuiet
in interface
ICacheProvider
objectKey
object
timeout
lastAccessTimeout
extra
public void shutdown()
shutdown
in interface
ICacheProvider
private void validateConfiguration()
|
ColdBox Platform v3.8.0 | ||||
FRAMES |