Skip to main content

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 Criterion object.

Class Query provides three main method: executeQuery, executeComponentQuery and executePageQuery, presented below. Each of these method return a list of items, paginated and sorted against the given parameters.

Method executeQuery

This method returns an list of Strings representing the TcmUris of the result. In terms of sorting, this is the most inefficient method because it first has to retrieve Component and Page models for all TcmUris, then sort them, then apply pagination on them and return only the result.

public List<String> executeQuery() {
    List<String> uris = new ArrayList<>(criterion.executeQuery());

    totalItemCount = uris.size();
    uris = applyPagination(uris);

    return uris;
}

Method executeComponentQuery

The method returns a list of ComponentMeta models that match the specified criteria. The method delegates the executeQuery call to the given Criterion and applies filter to item types Components only.

public List<ComponentMeta> executeComponentQuery() {
    List<String> uris = new ArrayList<>(criterion.executeQuery(
        new FilterImpl(ItemTypes.COMPONENT)));
    List<ComponentMeta> result = new ArrayList<>(uris.size());
    for (String uri : uris) {
        TcmUri tcmUri = new TcmUri("tcm:" + uri);
        ComponentMeta componentMeta = modelFactory.getModel(tcmUri);
        if (componentMeta != null) {
            result.add(componentMeta);
        }
    }

    totalItemCount = result.size();
    Collections.sort(result, sorter);
    result = applyPagination(result);

    return result;
}

Method executePageQuery

The method returns a list of PageMeta models that match the specified criteria.

public List<PageMeta> executePageQuery() {
    List<String> uris = new ArrayList<>(criterion.executeQuery(
        new FilterImpl(ItemTypes.PAGE)));
    List<PageMeta> result = new ArrayList<>(uris.size());

    for (String uri : uris) {
        TcmUri tcmUri = new TcmUri("tcm:" + uri);
        PageMeta pageMeta = modelFactory.getModel(tcmUri);
        if (pageMeta != null) {
            result.add(pageMeta);
        }
    }
    totalItemCount = result.size();

    if (sorter != null) {
        Collections.sort(result, sorter);
    }

    result = applyPagination(result);
    return result;
}



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