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 ehcache.properties file present at run-time in the application's class-path, or in the Toolkit configuration file toolkit.properties.

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)) {
            remove(key);
            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)) {
        cache.replace(element);
    } else {
        cache.put(element);
    }
}

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);
}



Comments

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: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , 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...

I Have Gone Dark

Maybe it's the Holidays, but my mood has gone pretty dark. That is, regarding the look and feel of my computer and Tridion CME, of course. What I did was to dim the lights on the operating system, so I installed Placebo themes for Windows 7 . I went for the Ashtray look -- great name :) My VM looks now like this: But, once you change the theme on Windows, you should 'match' the theme of your applications. Some skin easily, some not. The Office suite has an in-built scheme, which can be set to Black , but it doesn't actually dim the ribbon tool bars -- it looks quite weird. Yahoo Messenger is skinnable, but you can't change the big white panels where you actually 'chat'. Skype is not skinnable at all. For Chrome, there are plenty of grey themes. Now i'm using Pro Grey . But then I got into changing the theme of websites. While very few offer skinnable interfaces (as GMail does), I had to find a way to darken the websites... Enter Stylish -- a pl...

REL Standard Tag Library

The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...