ebox.system.cache.concurrent.Callable interface">
Callable Overview  Package   Class 
ColdBox Platform - CacheBox Version 1.1
FRAMES  

cachebox.system.cache
Interface IColdboxApplicationCache

WEB-INF.cftags.interface
        extended by cachebox.system.cache.ICacheProvider
            extended by cachebox.system.cache.IColdboxApplicationCache
All Known Implementing Classes:
CFColdBoxProvider , CacheBoxColdBoxProvider , MockProvider 
public interface IColdboxApplicationCache

extends ICacheProvider

The main interface to produce a ColdBox Application cache

Method Summary
 void clearAllEvents([boolean async])
          Clears all events from the cache
 void clearAllViews([boolean async])
          Clears all views from the cache
 void clearEvent(string eventsnippet, [string queryString=''])
          Clears all the event permutations from the cache according to snippet and querystring
 void clearEventMulti(any eventsnippets, [string queryString=''])
          Clears all the event permutations from the cache according to the list of snippets and querystrings
 void clearView(string 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<cachebox.system.web.Controller> getColdbox()
          Get the coldbox application reference as cachebox
 string getCustomPluginCacheKeyPrefix()
          Get the custom plugin cache key prefix
 string getEventCacheKeyPrefix()
          Get the event cache key prefix
 EventURLFacade getEventURLFacade()
          Get the event caching URL facade utility
 string getHandlerCacheKeyPrefix()
          Get the handler cache key prefix
 string getInterceptorCacheKeyPrefix()
          Get the interceptor cache key prefix
 ItemTypeCount getItemTypes()
          Get the item types counts of the cache
 string getPluginCacheKeyPrefix()
          Get the plugin cache key prefix
 string getViewCacheKeyPrefix()
          Get the cached view key prefix
 void setColdbox(any<cachebox.system.web.Controller> coldbox)
          Set the coldbox application reference
 
Methods inherited from class cachebox.system.cache.ICacheProvider
clear, clearAll, clearQuiet, clearStatistics, configure, expireAll, expireObject, get, getCacheFactory, getCachedObjectMetadata, getConfiguration, getEventManager, getKeys, getName, getObjectStore, getQuiet, getSize, getStats, getStoreMetadataKeyMap, getStoreMetadataReport, isEnabled, isExpired, isReportingEnabled, lookup, lookupQuiet, reap, set, setCacheFactory, setConfiguration, setEventManager, setName, setQuiet, shutdown
 
Methods inherited from class WEB-INF.cftags.interface
 

Method Detail

clearAllEvents

public void clearAllEvents([boolean async])
Clears all events from the cache.

Parameters:
async - Run command asynchronously or not

clearAllViews

public void clearAllViews([boolean async])
Clears all views from the cache.

Parameters:
async - Run command asynchronously or not

clearEvent

public void clearEvent(string eventsnippet, [string 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

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, [string 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

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(string viewSnippet)
Clears all view name permutations from the cache according to the view name.

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.

Parameters:
viewSnippets - The comma-delimmitted list or array of view snippet to clear on. Can be partial or full

getColdbox

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

getCustomPluginCacheKeyPrefix

public string getCustomPluginCacheKeyPrefix()
Get the custom plugin cache key prefix

getEventCacheKeyPrefix

public string getEventCacheKeyPrefix()
Get the event cache key prefix

getEventURLFacade

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

getHandlerCacheKeyPrefix

public string getHandlerCacheKeyPrefix()
Get the handler cache key prefix

getInterceptorCacheKeyPrefix

public string getInterceptorCacheKeyPrefix()
Get the interceptor cache key prefix

getItemTypes

public ItemTypeCount getItemTypes()
Get the item types counts of the cache. These are calculated according to the prefixes set.

getPluginCacheKeyPrefix

public string getPluginCacheKeyPrefix()
Get the plugin cache key prefix

getViewCacheKeyPrefix

public string getViewCacheKeyPrefix()
Get the cached view key prefix

setColdbox

public void setColdbox(any<cachebox.system.web.Controller> coldbox)
Set the coldbox application reference

Parameters:
coldbox - The coldbox application reference as type: cachebox.system.web.Controller
Overview  Package   Class 
ColdBox Platform - CacheBox Version 1.1
FRAMES