Skip to main content

Toolkit - Model Factory

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

This post presents the Model Factory, an layer that offers CRUD operations on models backed by a cache and a file system provider.

The Model Factory is a singleton that allows the creation, retrieval, update and deletion of a model. It works using a CacheFactory and a File System Provider that acts as a data abstraction layer.

The Model Factory works on two types of models only: ComponentMeta and PageMeta. They are both generics passed to the factory methods or inferred from the returned type.

Method getOrCreate(TcmUri)

This method tries first to read a model from the cache. If it doesn't exist in cache, it tries to read it from the file system provider. If there is no such model on disk, then it will proceed to create a stub model that only has its TcmUri property set. The idea is that the user will populate the other model properties and will execute a updateModel.

public <T extends ItemMeta> T getOrCreateModel(TcmUri tcmUri) {
    T model;
    String key = cacheFactory.getKey(tcmUri);
    CacheElement<T> cacheElement = cacheFactory.get(key);

    if (cacheElement == null) {
        model = modelProvider.read(tcmUri);
    } else {
        model = cacheElement.getPayload();
    }

    if (model == null) {
        model = modelProvider.create(tcmUri);
        cacheFactory.put(key, model);
    }

    return model;
}

Method getModel(TcmUri)

This method is the most used method of the factory. It provides the read operation of a model from either the internal cache or from the file system provider. Usually the 'write' operations of this factory are called only by the Deployer extensions, during the publish/unpublish activities. The 'read' operation is used mainly in the Toolkit CD API.

public <T extends ItemMeta> T getModel(TcmUri tcmUri) {
    T model;
    String key = cacheFactory.getKey(tcmUri);
    CacheElement<T> cacheElement = cacheFactory.get(key);

    if (cacheElement == null) {
        model = modelProvider.read(tcmUri);
        if (model != null && model.getLastPublished() == null) {
            model = null;
        }
        cacheFactory.put(key, model);
    } else {
        model = cacheElement.getPayload();
    }

    return model;
}

Method updateModel(T model)

This method is a write operation that persists the model sent as parameter to the file system. It also places the updated model in the cache.

public <T extends ItemMeta> void updateModel(T model) {
    TcmUri tcmUri = model.getTcmUri();
    String key = cacheFactory.getKey(tcmUri);
    model = modelProvider.update(model);
    cacheFactory.put(key, model);
}

Method removeModel(TcmUri)

This method is a write operation that deletes a model from the file system and removes it from the cache.

public boolean removeModel(TcmUri tcmUri) {
    String key = cacheFactory.getKey(tcmUri);
    cacheFactory.remove(key);

    return modelProvider.delete(tcmUri);
}



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

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