lucee.Component cachebox.system.cache.providers.LuceeProvider
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Author: Luis Majano Description: This CacheBox provider communicates with the built in caches in the Lucee 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 advising to events. |
void
|
clearStatistics()
clear the cache stats: Not enabled in this provider. |
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
|
getCachedObjectMetadata(any objectKey)
get an object's cached metadata. |
any
|
getCacheFactory()
get the associated cache factory. |
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 underlying cache engine: Not enabled in this provider. |
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: Stats not available on lucee. |
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. |
private any
|
isDefaultCache()
Checks if the default cache is in use. |
any
|
isEnabled()
|
any
|
isExpired(any objectKey)
Not implemented by this cache. |
any
|
isReportingEnabled()
|
any
|
lookup(any objectKey)
check if object in cache. |
any
|
lookupQuiet(any objectKey)
check if object in cache with no stats: Stats not available on lucee. |
void
|
reap()
Not implemented by this cache. |
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 advising to events. |
void
|
shutdown()
shutdown the cache. |
private void
|
validateConfiguration()
Validate the incoming configuration and make necessary defaults. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Method Detail |
---|
clear an element from cache
clear
in interface
ICacheProvider
objectKey
clear all elements from cache
clearAll
in interface
ICacheProvider
Clear by key snippet
keySnippet
regex
async
clear with no advising to events
clearQuiet
in interface
ICacheProvider
objectKey
clear the cache stats: Not enabled in this provider
clearStatistics
in interface
ICacheProvider
configure the cache for operation
configure
in interface
ICacheProvider
not implemented by cache
expireAll
in interface
ICacheProvider
not implemented by cache
expireObject
in interface
ICacheProvider
objectKey
get an item from cache
get
in interface
ICacheProvider
objectKey
get an object's cached metadata
getCachedObjectMetadata
in interface
ICacheProvider
objectKey
get the associated cache factory
getCacheFactory
in interface
ICacheProvider
get the cache configuration structure
getConfiguration
in interface
ICacheProvider
get the event manager
getEventManager
in interface
ICacheProvider
get all the keys in this provider
getKeys
in interface
ICacheProvider
get the cache name
getName
in interface
ICacheProvider
Returns the underlying cache engine: Not enabled in this provider
getObjectStore
in interface
ICacheProvider
Tries to get an object from the cache, if not found, it calls the 'produce' closure to produce the data and cache it
objectKey
produce
timeout
lastAccessTimeout
extra
get an item silently from cache, no stats advised: Stats not available on lucee
getQuiet
in interface
ICacheProvider
objectKey
get cache size
getSize
in interface
ICacheProvider
getStats
in interface
ICacheProvider
Get a key lookup structure where cachebox can build the report on. Ex: [timeout=timeout,lastAccessTimeout=idleTimeout]. It is a way for the visualizer to construct the columns correctly on the reports
getStoreMetadataKeyMap
in interface
ICacheProvider
get the cache's metadata report
getStoreMetadataReport
in interface
ICacheProvider
Checks if the default cache is in use
isEnabled
in interface
ICacheProvider
Not implemented by this cache
isExpired
in interface
ICacheProvider
objectKey
isReportingEnabled
in interface
ICacheProvider
check if object in cache
lookup
in interface
ICacheProvider
objectKey
check if object in cache with no stats: Stats not available on lucee
lookupQuiet
in interface
ICacheProvider
objectKey
Not implemented by this cache
reap
in interface
ICacheProvider
set an object in cache
set
in interface
ICacheProvider
objectKey
object
timeout
lastAccessTimeout
extra
set the associated cache factory
setCacheFactory
in interface
ICacheProvider
cacheFactory
set the cache configuration structure
setConfiguration
in interface
ICacheProvider
configuration
set the event manager
setEventManager
in interface
ICacheProvider
EventManager
set the cache name
setName
in interface
ICacheProvider
name
set an object in cache with no advising to events
setQuiet
in interface
ICacheProvider
objectKey
object
timeout
lastAccessTimeout
extra
shutdown the cache
shutdown
in interface
ICacheProvider
Validate the incoming configuration and make necessary defaults