[Tip of the Week] Configuring Additional CacheBox Caches

Every ColdBox install comes with an instance of the CacheBox cache aggregator ready to go. There are two caches that have to be defined: default, and template. The former is the default provider used if you don’t specify another one. The latter provider is used internally for cached events and views. What’s cool about CacheBox as a cache aggregator is that you can configure as many named providers as you like to report and tune separate areas of your application.

Adding an additional named cache is easy and has virtually no overhead since most providers don’t use any memory until you begin populating them with data. Let’s start by taking a look at your cache debug monitor:

Now, first off you might be wondering how the default and template cache are defined since you might not have any CacheBox-specific configuration in your app. Don’t worry-- if you don’t supply any CacheBox configuration, it defaults to the settings found in /coldbox/system/web/config/CacheBox.cfc. Once you do begin including config for CacheBox, you’ll need to include the default and template caches.

Where you store your CacheBox config is completely configurable, but the two most common places is a “cachebox” struct in your main /congig/ColdBox.cfc file, or in a separate file /config/CacheBox.cfc that works just like the main config. My preference is the separate CacheBox.cfc file for organization. You can get started by simply making a copy of the default CacheBox.cfc in your app’s config directory.

To add additional caches, you just need to add more nested structs to the “cachebox.caches” struct like so (I omitted all the default and template details for brevity):

cacheBox = {
defaultCache = {

// Register all the custom named caches you like here
caches = {
template = {

// My new named cache!
myCache = {
provider = “coldbox.system.cache.providers.CacheBoxColdBoxProvider”,
properties = {
evictionPolicy = “LRU”,
maxObjects = 300,
objectStore = “ConcurrentSoftReferenceStore”

Now, reinit your application and refresh the cache debug screen. Your new cache name should show up in the drop down for you to view the stats and contents of it.

Using your new cache is also easy. In a handler for example, the following code is all that is needed:
var myCache = CacheBox.getCache(“myCache”);

If you want to wire your new cache into a model, the following DSL will also work:
component {
property name=‘myCache’ inject=‘cachebox:myCache’;

See more config options as well as a list of all the CacheBox providers you can use here: http://wiki.coldbox.org/wiki/CacheBox.cfm#Caches

P.S. Don’t forget to add a debugPassword setting into your app to ensure that you are the only one who can fool around with your CacheBox debug panel. The URL only changes slightly when you have password:



ColdBox Platform Evangelist
Ortus Solutions, Corp

E-mail: brad@coldbox.org
ColdBox Platform: http://www.coldbox.org
Blog: http://www.codersrevolution.com

Great information, thanks to sharing…