ColdBox Platform Version 2.6.3

coldbox.system.cache
Class MTCacheManager

WEB-INF.cftags.component
        extended by coldbox.system.cache.CacheManager
            extended by coldbox.system.cache.MTCacheManager

public class MTCacheManager
extends CacheManager

The multi-threaded cache manager.


Method Summary
 void clearAllEvents([boolean async='true'])
          Clears all events from the cache.
 void clearAllViews([boolean async='true'])
          Clears all views from the cache.
 void clearByKeySnippet(string keySnippet, [boolean regex='false'], [boolean async='true'])
          Clears keys using the passed in object key snippet
 void clearEvent(string eventsnippet, [string queryString=''], [boolean async='true'])
          Clears all the event permuations from the cache.
 void clearView(string viewSnippet, [boolean async='true'])
          Clears all view name permutations from the cache according to the view name.
 void expireAll([boolean async='true'])
          Expire All Objects. Use this instead of clear() from within handlers or any cached object, this sets the metadata for the objects to expire in the next request. Note that this is not an inmmediate expiration. Clear should only be used from outside a cached object
 void expireByKeySnippet(string keySnippet, [boolean regex='false'], [boolean async='true'])
          Same as expireKey but can touch multiple objects depending on the keysnippet that is sent in.
 void expireKey(string objectKey, [boolean async='true'])
          Expire an Object. Use this instead of clearKey() from within handlers or any cached object, this sets the metadata for the objects to expire in the next request. Note that this is not an inmmediate expiration. Clear should only be used from outside a cached object
private void initPool()
          Initialize and set the internal object Pool
 void reap()
          Reap the cache.
 
Methods inherited from class coldbox.system.cache.CacheManager
ThresholdChecks, announceExpiration, clear, clearKey, clearKeyMulti, configure, get, getCacheConfigBean, getCacheStats, getCachedObjectMetadata, getCachedObjectMetadataMulti, getItemTypes, getMulti, getObjectPool, getSize, getUtil, geteventURLFacade, getjavaRuntime, getpool_metadata, init, lookup, set, setCacheConfigBean, setMulti, setevictionPolicy
 
Methods inherited from class WEB-INF.cftags.component
 

Method Detail

clearAllEvents

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

Overrides:
clearAllEvents in class CacheManager
Parameters:
async - Run asynchronously or not

clearAllViews

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

Overrides:
clearAllViews in class CacheManager
Parameters:
async - Run asynchronously or not

clearByKeySnippet

public void clearByKeySnippet(string keySnippet, [boolean regex='false'], [boolean async='true'])
Clears keys using the passed in object key snippet

Overrides:
clearByKeySnippet in class CacheManager
Parameters:
keySnippet - The key snippet to use to clear keys. It matches using findnocase
regex - Use regex or not
async - Run asynchronously or not, defaults to true

clearEvent

public void clearEvent(string eventsnippet, [string queryString=''], [boolean async='true'])
Clears all the event permuations from the cache.

Overrides:
clearEvent in class CacheManager
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
async - Run asynchronously or not

clearView

public void clearView(string viewSnippet, [boolean async='true'])
Clears all view name permutations from the cache according to the view name.

Overrides:
clearView in class CacheManager
Parameters:
viewSnippet - The view name snippet to purge from the cache
async - Run asynchronously or not

expireAll

public void expireAll([boolean async='true'])
Expire All Objects. Use this instead of clear() from within handlers or any cached object, this sets the metadata for the objects to expire in the next request. Note that this is not an inmmediate expiration. Clear should only be used from outside a cached object

Overrides:
expireAll in class CacheManager
Parameters:
async - Run asynchronously or not

expireByKeySnippet

public void expireByKeySnippet(string keySnippet, [boolean regex='false'], [boolean async='true'])
Same as expireKey but can touch multiple objects depending on the keysnippet that is sent in.

Overrides:
expireByKeySnippet in class CacheManager
Parameters:
keySnippet - The key snippet to use
regex - Use regex or not
async - Run asynchronously or not

expireKey

public void expireKey(string objectKey, [boolean async='true'])
Expire an Object. Use this instead of clearKey() from within handlers or any cached object, this sets the metadata for the objects to expire in the next request. Note that this is not an inmmediate expiration. Clear should only be used from outside a cached object

Overrides:
expireKey in class CacheManager
Parameters:
objectKey
async - Run asynchronously or not

initPool

private void initPool()
Initialize and set the internal object Pool

Overrides:
initPool in class CacheManager

reap

public void reap()
Reap the cache.

Overrides:
reap in class CacheManager

ColdBox Platform Version 2.6.3