Skip to main content

Toolkit - File System Provider

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

This post explains the logic in the FileSystemProvider class that perform the actual CRUD operations on the JSON model files as it interacts with the underlying file system.

The provider handles also the serialization/deserialization between model objects and JSON by making use of the FasterXML Jackson serializer.

The FileSystemProvider is a singleton that implements the following methods:

Method create(TcmUri)

This is one of the trickier methods of the provider because it has to create different stub objects based on the type of the TcmUri passed as parameter. Namely, it will create either a ComponentMetaImpl or a PageMetaImpl object and it will populate its TcmUri property. I chose to implement this method using reflection, because it can provide more flexibility in the future, in case other types are required to be initialized.

public <T extends ItemMeta> T create(TcmUri tcmUri) {
    T result;
    Class<T> aClass = ModelUtils.getClass(tcmUri);
    try {
        result = aClass.newInstance();
        Method setTcmUri = aClass.getMethod("setTcmUri", TcmUri.class);
        setTcmUri.invoke(result, tcmUri);
    } catch (InstantiationException | IllegalAccessException |
            NoSuchMethodException | InvocationTargetException e) {
        throw new ModelException(e);
    }

    return result;
}

Method read(TcmUri)

The method uses the PathMapper to identify the path of a JSON file on the file system, it retrieves it and then it performs a deserialize using the Jackson deserializer. It also identifies the type of the model to be returned by looking at the type inside the TcmUri passed as parameter.

public <T extends ItemMeta> T read(TcmUri tcmUri) {
    String path = pathMapper.getModelAbsolutePath(tcmUri);
    File file = new File(path);
    if (!file.exists()) {
        return null;
    }

    try {
        Class<T> aClass = ModelUtils.getClass(tcmUri);
        T model = serializer.deserialize(file, aClass);
        return model;
    } catch (SerializationException se) {
        throw new ModelException(se);
    }
}

Method update(T model)

The method uses the PathMapper to identify the path of a JSON file on the file system, and if it doesn't exist, it creates the folder structure up until the model JSON file. It then uses the Jackson serializer to serialize the model passed as parameter and write it to the file system.

public <T extends ItemMeta> T update(T model) {
    TcmUri tcmUri = model.getTcmUri();
    String path = pathMapper.getModelAbsolutePath(tcmUri);
    File file = new File(path);

    if (!file.exists()) {
        File directory = file.getParentFile();
        if (!directory.exists()) {
            if (!directory.mkdirs()) {
                log.error("Directory {} was not created", directory);
            }
        }
    }

    serializer.serialize(file, model);

    return model;
}

Method delete(TcmUri)

The method uses the PathMapper to identify the JSON model file on the file system and then it deletes it.

This is one of the tricker methods in the provider, because it needs to perform a cleanup once a directory is left empty after a model has been deleted.

public boolean delete(TcmUri tcmUri) {
    String path = pathMapper.getModelAbsolutePath(tcmUri);
    File file = new File(path);

    if (file.exists()) {
        if (file.delete()) {
            if (isCleanup) {
                deleteEmptyFolders(file.getParentFile());
            }
            return true;
        }
    }

    return false;
}



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