IColdboxApplicationCache

coldbox.system.cache

Interface IColdboxApplicationCache

coldbox.system.cache.ICacheProvider
    coldbox.system.cache.IColdboxApplicationCache

DEPRECATED: USE coldbox.system.cache.providers.IColdBoxProvider instead.

Class Attributes:

None

Method Summary
`void`	clearAllEvents([any async]) Clears all events from the cache.
`void`	clearAllViews([any async]) 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`	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 coldbox) Set the coldbox application reference.

Methods inherited from class `coldbox.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 coldbox.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

Method Detail

clearAllEvents

public void clearAllEvents([any async])

Clears all events from the cache.

Parameters:: async - Run command asynchronously or not

clearAllViews

public void clearAllViews([any async])

Clears all views from the cache.

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

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

Parameters:: eventsnippets - The comma-delimited list event snippet to clear on. Can be partial or full; queryString - The comma-delimited 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.

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-delimited list or array of view snippet to clear on. Can be partial or full

getColdbox

public any getColdbox()

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

getEventCacheKeyPrefix

public any getEventCacheKeyPrefix()

Get the event cache key prefix

getEventURLFacade

public any getEventURLFacade()

Get the event caching URL facade utility

getViewCacheKeyPrefix

public any getViewCacheKeyPrefix()

Get the cached view key prefix

setColdbox

public void setColdbox(any coldbox)

Set the coldbox application reference

Parameters:: coldbox - The coldbox application reference as type: coldbox.system.web.Controller