coldbox.system.cache.providers

Class CFColdBoxProvider

lucee.Component
    extended by coldbox.system.cache.AbstractCacheBoxProvider
      extended by coldbox.system.cache.providers.CFProvider
        extended by coldbox.system.cache.providers.CFColdBoxProvider
All Implemented Interfaces:
ICacheProvider , IColdBoxProvider

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This CacheBox provider communicates with the built in caches in the Adobe Engine for ColdBox Apps

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
  • author : Luis Majano
    •  
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any clearAllEvents([boolean async='false'])
         Clears all events from the cache.
    any clearAllViews([boolean async='false'])
         Clears all views from the cache.
    any clearEvent(any eventSnippet, [any queryString=''])
         Clears all the event permutations from the cache according to snippet and querystring.
    any clearEventMulti(any eventsnippets, [any queryString=''])
         Clears all the event permutations from the cache according to the list of snippets and querystrings.
    any clearView(any viewSnippet)
         Clears all view name permutations from the cache according to the view name.
    any clearViewMulti(any viewSnippets)
         Clears all view name permutations from the cache according to the view name.
    any getColdbox()
         Get the coldbox application reference as coldbox.
    any getEventCacheKeyPrefix()
         Get the event cache key prefix which is necessary for event caching.
    any getEventURLFacade()
         Get the event caching URL facade utility that determines event caching.
    any getViewCacheKeyPrefix()
         Get the cached view key prefix which is necessary for view caching.
    any setColdBox(any<Controller> coldbox)
         Set the ColdBox linkage into the provider.
     
    Methods inherited from class coldbox.system.cache.providers.CFProvider
    clear, clearAll, clearQuiet, clearStatistics, configure, expireAll, expireObject, get, getCachedObjectMetadata, getElementCleaner, getKeys, getObjectStore, getOrSet, getQuiet, getSize, getStats, getStoreMetadataKeyMap, getStoreMetadataReport, isClusterCoherent, isDefaultCache, isExpired, isNodeCoherent, isTerracotaClustered, lookup, lookupQuiet, reap, set, setElementCleaner, setQuiet, shutdown, validateConfiguration
     
    Methods inherited from class coldbox.system.cache.AbstractCacheBoxProvider
    clearByKeySnippet, clearMulti, getCachedObjectMetadataMulti, getCacheFactory, getCacheId, getConfiguration, getEnabled, getEventManager, getMemento, getMulti, getName, getReportingEnabled, getUtility, getUuidHelper, inThread, isEnabled, isReportingEnabled, lookupMulti, randomUUID, setCacheFactory, setCacheId, setConfiguration, setEnabled, setEventManager, setMulti, setName, setReportingEnabled, setStats, setUtility, setUuidHelper, statusCheck
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Constructor

    Method Detail

    clearAllEvents

    public any clearAllEvents([boolean async='false'])

    Clears all events from the cache.

    Specified by:
    clearAllEvents in interface IColdBoxProvider
    Parameters:
    async - If implemented, determines async or sync clearing.
    Returns:
    IColdboxApplicationCache

    clearAllViews

    public any clearAllViews([boolean async='false'])

    Clears all views from the cache.

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

    clearEvent

    public any 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 IColdBoxProvider
    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
    Returns:
    IColdboxApplicationCache

    clearEventMulti

    public any 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 IColdBoxProvider
    Parameters:
    eventsnippets
    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
    Returns:
    IColdboxApplicationCache

    clearView

    public any clearView(any viewSnippet)

    Clears all view name permutations from the cache according to the view name

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

    clearViewMulti

    public any clearViewMulti(any viewSnippets)

    Clears all view name permutations from the cache according to the view name.

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

    getColdbox

    public any getColdbox()

    Get the coldbox application reference as coldbox.system.web.Controller

    Specified by:
    getColdbox in interface IColdBoxProvider
    Returns:
    coldbox.system.web.Controller

    getEventCacheKeyPrefix

    public any getEventCacheKeyPrefix()

    Get the event cache key prefix which is necessary for event caching

    Specified by:
    getEventCacheKeyPrefix in interface IColdBoxProvider

    getEventURLFacade

    public any getEventURLFacade()

    Get the event caching URL facade utility that determines event caching

    Specified by:
    getEventURLFacade in interface IColdBoxProvider
    Returns:
    coldbox.system.cache.util.EventURLFacade

    getViewCacheKeyPrefix

    public any getViewCacheKeyPrefix()

    Get the cached view key prefix which is necessary for view caching

    Specified by:
    getViewCacheKeyPrefix in interface IColdBoxProvider

    setColdBox

    public any setColdBox(any<Controller> coldbox)

    Set the ColdBox linkage into the provider

    Specified by:
    setColdBox in interface IColdBoxProvider
    Parameters:
    coldbox - The ColdBox controller
    Returns:
    IColdboxApplicationCache