|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.cache.config.CacheBoxConfig
public class CacheBoxConfig
This is a CacheBox configuration object. You can use it to configure a CacheBox instance
Constructor Summary | |
---|---|
init([string XMLConfig=''], [any CFCConfig], [string CFCConfigPath])
Constructor |
Method Summary | |
---|---|
any |
cache(string name, [string provider='[runtime expression]'], [struct properties='[runtime expression]'])
Add a new cache configuration |
boolean |
cacheExists(string name)
Check if a cache definition exists |
any |
defaultCache([numeric objectDefaultTimeout], [numeric objectDefaultLastAccessTimeout], [numeric reapFrequency], [numeric maxObjects], [numeric freeMemoryPercentageThreshold], [boolean useLastAccessTimeouts], [string evictionPolicy], [numeric evictCount], [string objectStore], [boolean coldboxEnabled])
Add a default cache configuration |
struct |
getCache(string name)
Get a specifed cache definition |
struct |
getCaches()
Get the configured caches |
struct |
getDefaultCache()
Get the defaultCache definition |
struct |
getDefaults()
Get the default CacheBox settings |
array |
getListeners()
Get the configured listeners |
string |
getLogBoxConfig()
Get the logBox Configuration file to use |
struct |
getMemento()
Get the instance data |
struct |
getScopeRegistration()
Get the scope registration details |
any |
listener(string class, [struct properties='[runtime expression]'], [string name=''])
Add a new listener configuration |
void |
loadDataDSL(struct rawDSL)
Load a data configuration CFC data DSL |
any |
logBoxConfig(string config)
Set the logBox Configuration to use |
void |
parseAndLoad(any xmlDoc)
Parse and load a config xml object |
void |
reset()
Reset the configuration |
void |
resetCaches()
Reset the set caches |
void |
resetDefaultCache()
Reset the default cache configurations |
void |
resetListeners()
Reset the cache listeners |
any |
scopeRegistration([boolean enabled='[runtime expression]'], [string scope='[runtime expression]'], [string key='[runtime expression]'])
Use to define cachebox factory scope registration |
void |
validate()
Validates the configuration |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init([string XMLConfig=''], [any CFCConfig], [string CFCConfigPath])
XMLConfig
- The xml configuration file to use instead of a programmatic approachCFCConfig
- The cacheBox Data Configuration CFCCFCConfigPath
- The cacheBox Data Configuration CFC path to useMethod Detail |
---|
public any cache(string name, [string provider='[runtime expression]'], [struct properties='[runtime expression]'])
name
- The name of the cacheprovider
- The cache provider class, defaults to: coldbox.system.cache.providers.CacheBoxProviderproperties
- The structure of properties for the cachepublic boolean cacheExists(string name)
name
- The cache to checkpublic any defaultCache([numeric objectDefaultTimeout], [numeric objectDefaultLastAccessTimeout], [numeric reapFrequency], [numeric maxObjects], [numeric freeMemoryPercentageThreshold], [boolean useLastAccessTimeouts], [string evictionPolicy], [numeric evictCount], [string objectStore], [boolean coldboxEnabled])
objectDefaultTimeout
objectDefaultLastAccessTimeout
reapFrequency
maxObjects
freeMemoryPercentageThreshold
useLastAccessTimeouts
evictionPolicy
evictCount
objectStore
coldboxEnabled
public struct getCache(string name)
name
- The cache configuration to retrievepublic struct getCaches()
public struct getDefaultCache()
public struct getDefaults()
public array getListeners()
public string getLogBoxConfig()
public struct getMemento()
public struct getScopeRegistration()
public any listener(string class, [struct properties='[runtime expression]'], [string name=''])
class
- The class of the listenerproperties
- The structure of properties for the listnername
- The name of the listenerpublic void loadDataDSL(struct rawDSL)
rawDSL
- The data configuration DSL structurepublic any logBoxConfig(string config)
config
- The configuration file to usepublic void parseAndLoad(any xmlDoc)
xmlDoc
- The xml document object to use for parsing.public void reset()
public void resetCaches()
public void resetDefaultCache()
public void resetListeners()
public any scopeRegistration([boolean enabled='[runtime expression]'], [string scope='[runtime expression]'], [string key='[runtime expression]'])
enabled
- Enable registrationscope
- The scope to register on, defaults to application scopekey
- The key to use in the scope, defaults to cacheboxpublic void validate()
|
ColdBox Platform v3.8.0 | ||||
FRAMES |