ColdBox Platform v3.8.0

coldbox.system.cache.providers
Class CacheBoxColdBoxProvider

WEB-INF.cftags.component
        extended by coldbox.system.cache.AbstractCacheBoxProvider
            extended by coldbox.system.cache.providers.CacheBoxProvider
                extended by coldbox.system.cache.providers.CacheBoxColdBoxProvider
All Implemented Interfaces:
ICacheProvider , IColdboxApplicationCache

public class CacheBoxColdBoxProvider
extends CacheBoxProvider
Constructor Summary
init()
          Constructor
 
Method Summary
 void clearAllEvents([any async='false'])
          Clears all events from the cache
 void clearAllViews([any async='false'])
          Clears all views from the cache
 void clearEvent(any eventsnippet, [any queryString=''])
          Clears all the event permutations from the cache according to snippet and querystring
 void clearEventMulti(any eventsnippets, [any queryString=''])
          Clears all the event permutations from the cache according to the list of snippets and querystrings
 void clearView(any viewSnippet)
          Clears all view name permutations from the cache according to the view name
 void clearViewMulti(any viewSnippets)
          Clears all view name permutations from the cache according to the view name
 any<Controller> getColdbox()
          Get the coldbox application reference as coldbox
 any getEventCacheKeyPrefix()
          Get the event cache key prefix
 any getEventURLFacade()
          Get the event caching URL facade utility
 any getViewCacheKeyPrefix()
          Get the cached view key prefix
 void setColdbox(any<Controller> coldbox)
          Set the coldbox application reference
 
Methods inherited from class coldbox.system.cache.providers.CacheBoxProvider
_reap, announceExpiration, clear, clearAll, clearByKeySnippet, clearKey, clearMulti, clearQuiet, configure, expireAll, expireByKeySnippet, expireObject, get, getCachedObjectMetadata, getCachedObjectMetadataMulti, getJavaRuntime, getKeys, getMulti, getObjectStore, getOrSet, getQuiet, getSize, getStoreMetadataKeyMap, getStoreMetadataReport, isExpired, locateEvictionPolicy, locateObjectStore, lookup, lookupMulti, lookupQuiet, reap, set, setMulti, setQuiet, shutdown, thresholdChecks, validateConfiguration
 
Methods inherited from class coldbox.system.cache.AbstractCacheBoxProvider
clearStatistics, getCacheFactory, getCacheID, getConfiguration, getEventManager, getMemento, getName, getStats, getUtil, isEnabled, isReportingEnabled, setCacheFactory, setConfiguration, setEventManager, setName, statusCheck
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()
Constructor

Method Detail

clearAllEvents

public void clearAllEvents([any async='false'])
Clears all events from the cache.

Specified by:
clearAllEvents in interface IColdboxApplicationCache
Parameters:
async - Run command asynchronously or not

clearAllViews

public void clearAllViews([any async='false'])
Clears all views from the cache.

Specified by:
clearAllViews in interface IColdboxApplicationCache
Parameters:
async - Run command asynchronously or not

clearEvent

public void clearEvent(any eventsnippet, [any queryString=''])
Clears all the event permutations from the cache according to snippet and querystring. Be careful when using incomplete event name with query strings as partial event names are not guaranteed to match with query string permutations

Specified by:
clearEvent in interface IColdboxApplicationCache
Parameters:
eventsnippet - The event snippet to clear on. Can be partial or full
queryString - If passed in, it will create a unique hash out of it. For purging purposes

clearEventMulti

public void clearEventMulti(any eventsnippets, [any queryString=''])
Clears all the event permutations from the cache according to the list of snippets and querystrings. Be careful when using incomplete event name with query strings as partial event names are not guaranteed to match with query string permutations

Specified by:
clearEventMulti in interface IColdboxApplicationCache
Parameters:
eventsnippets - The comma-delimmitted list event snippet to clear on. Can be partial or full
queryString - The comma-delimmitted list of queryStrings passed in. If passed in, it will create a unique hash out of it. For purging purposes. If passed in the list length must be equal to the list length of the event snippets passed in.

clearView

public void clearView(any viewSnippet)
Clears all view name permutations from the cache according to the view name.

Specified by:
clearView in interface IColdboxApplicationCache
Parameters:
viewSnippet - The view name snippet to purge from the cache

clearViewMulti

public void clearViewMulti(any viewSnippets)
Clears all view name permutations from the cache according to the view name.

Specified by:
clearViewMulti in interface IColdboxApplicationCache
Parameters:
viewSnippets - The comma-delimmitted list or array of view snippet to clear on. Can be partial or full

getColdbox

public any<Controller> getColdbox()
Get the coldbox application reference as coldbox.system.web.Controller

Specified by:
getColdbox in interface IColdboxApplicationCache

getEventCacheKeyPrefix

public any getEventCacheKeyPrefix()
Get the event cache key prefix

Specified by:
getEventCacheKeyPrefix in interface IColdboxApplicationCache

getEventURLFacade

public any getEventURLFacade()
Get the event caching URL facade utility

Specified by:
getEventURLFacade in interface IColdboxApplicationCache

getViewCacheKeyPrefix

public any getViewCacheKeyPrefix()
Get the cached view key prefix

Specified by:
getViewCacheKeyPrefix in interface IColdboxApplicationCache

setColdbox

public void setColdbox(any<Controller> coldbox)
Set the coldbox application reference

Specified by:
setColdbox in interface IColdboxApplicationCache
Parameters:
coldbox - The coldbox application reference as coldbox.system.web.Controller

ColdBox Platform v3.8.0