coldbox.system.cache

Interface IColdboxApplicationCache

coldbox.system.cache.IColdboxApplicationCache
Class Attributes:
None
All Known Implementing Classes:
CacheBoxColdBoxProvider , CFColdBoxProvider , MockProvider , RailoColdboxProvider

The main interface to produce a ColdBox Application cache

Method Summary
void clearAllEvents([any<boolean> async])
     Clears all events from the cache.
void clearAllViews([any<Boolean> 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<Controller> getColdbox()
     Get the coldbox application reference as coldbox.
any getEventCacheKeyPrefix()
     Get the event cache key prefix.
any<EventURLFacade> 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.

Method Detail

clearAllEvents

public void clearAllEvents([any<boolean> async])

Clears all events from the cache.

Parameters:
async - Run command asynchronously or not

clearAllViews

public void clearAllViews([any<Boolean> 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-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.

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<Controller> getColdbox()

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


getEventCacheKeyPrefix

public any getEventCacheKeyPrefix()

Get the event cache key prefix


getEventURLFacade

public any<EventURLFacade> getEventURLFacade()

Get the event caching URL facade utility


getViewCacheKeyPrefix

public any getViewCacheKeyPrefix()

Get the cached view key prefix


setColdbox

public void setColdbox(any<Controller> coldbox)

Set the coldbox application reference

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