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

Toolkit - Dynamic Content Queries

This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the