Skip to main content

Toolkit - Cache Factory

This post if part of a series about the File System Toolkit - a custom content delivery API for SDL Tridion.

This post describes the Cache Factory the Toolkit uses to store commonly used models. The factory interfaces with an underlying EHCache instance named 'toolkit-cache'. Configuring the cache is possible either using a file present at run-time in the application's class-path, or in the Toolkit configuration file

Configuring the Toolkit cache is described in post Installation and Configuration. Creating an EHCache programmatically is described in post Create an EHCache Programmatically.

The Cache Factory is used mainly by the Model Factory in its interaction with storing/retrieving JSON models.

The factory provides three main operations: get, put, remove.

The EHCache stores CacheElement generic objects that are simply Java beans around properties: payload of generic type and a last-check timestamp used in determining a stale value.

public class CacheElement<T> {

    private long lastCheck;
    private T payload;

    public CacheElement(T payload) {
        this.payload = payload;
        lastCheck = System.currentTimeMillis();

    // accessor methods below...

Method get(String)

This method looks up a value in the cache based on the given key passed as parameter. If the value is present in the cache, it is returned in the form of a generic CacheElement object with a specific payload type.

There is one additional stale check, which I explain in the next post Cache Invalidation.

public <T> CacheElement<T> get(String key) {
    Element element = cache.get(key);
    if (element == null) {
        return null;
    } else {
        if (isStale(element)) {
            return null;

        CacheElement<T> result = (CacheElement<T>) element.getObjectValue();

        return result;

Method put(String, T payload)

This method stores a given payload object in the EHCache under a certain key. If the key is already present, it simply replaces its value.

public <T> void put(String key, T payload) {
    Element element = new Element(key, new CacheElement<>(payload));

    if (cache.isKeyInCache(key)) {
    } else {

Method remove(String)

Finally, the remove method removes an entry from the EHCache corresponding to the given key.

public boolean remove(String key) {
    return cache.remove(key);


Popular posts from this blog

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: I stumbled upon the following post from 2008 (!!!), , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven