Callable

Class

ColdBox Platform - CacheBox Version 1.1

FRAMES

cachebox.system.cache.providers
Class CacheBoxColdBoxProvider

WEB-INF.cftags.component
        cachebox.system.cache.AbstractCacheBoxProvider
            cachebox.system.cache.providers.CacheBoxProvider
                cachebox.system.cache.providers.CacheBoxColdBoxProvider

All Implemented Interfaces:: ICacheProvider , IColdboxApplicationCache

public class CacheBoxColdBoxProvider
extends CacheBoxProvider
extends CacheBoxProvider

Constructor Summary
`init()` Constructor

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.providers.CacheBoxProvider
`_reap, announceExpiration, clear, clearAll, clearByKeySnippet, clearKey, clearMulti, clearQuiet, configure, expireAll, expireByKeySnippet, expireObject, get, getCachedObjectMetadata, getCachedObjectMetadataMulti, getJavaRuntime, getKeys, getMulti, getObjectStore, getQuiet, getSize, getStoreMetadataKeyMap, getStoreMetadataReport, isExpired, locateEvictionPolicy, locateObjectStore, lookup, lookupMulti, lookupQuiet, reap, set, setMulti, setQuiet, shutdown, thresholdChecks, validateConfiguration`

Methods inherited from class cachebox.system.cache.providers.CacheBoxProvider

_reap, announceExpiration, clear, clearAll, clearByKeySnippet, clearKey, clearMulti, clearQuiet, configure, expireAll, expireByKeySnippet, expireObject, get, getCachedObjectMetadata, getCachedObjectMetadataMulti, getJavaRuntime, getKeys, getMulti, getObjectStore, getQuiet, getSize, getStoreMetadataKeyMap, getStoreMetadataReport, isExpired, locateEvictionPolicy, locateObjectStore, lookup, lookupMulti, lookupQuiet, reap, set, setMulti, setQuiet, shutdown, thresholdChecks, validateConfiguration

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

Constructor Detail

init

public init()

Constructor

Method Detail

clearAllEvents

public void clearAllEvents([boolean async])

Clears all events from the cache.

clearAllViews

public void clearAllViews([boolean async])

Clears all views from the cache.

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

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

clearView

public void clearView(string viewSnippet)

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

clearViewMulti

public void clearViewMulti(any viewSnippets)

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

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

Overview

Package