Skip to main content

Toolkit - Custom Tags Execution while Assembling

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

This post presents the TagFactory in charge with execution of custom tags for the Toolkit Component Presentations.

The content of Dynamic Component Presentations can contain custom tags in the form of <mytag>some body</mytag>. These XML-like nodes are backed by a Java class that is executed when the tag is rendered.

The configuration of tag names and Java class name is done in file toolkit.properties. More information is available in post Installation and Configuration.

The custom tag support uses the following concepts:
  • TagFactory -- the entry point into execution of tags for a piece of content;
  • TagSupport -- class that associates a tag name with a tag implementation class;
  • TagRenderer -- interface that a tag implementation class must implement;

TagRenderer Interface

This is the interface that any tag class must implement. It contains only one method, doTag that is called by the TagSupport class when the tag is executed.

public interface TagRenderer {
    String doTag(String tagBody);
}

A simple example tag follows:

public class MyTag implements TagRenderer {
    public String doTag(String tagBody) {
        return tagBody.toUpperCase();
    }
}

TagSupport Class

This class represents an association between a tag name and a tag implementing class. The only operation this class defines is an execute(String) method. This calls method doTag(String) on the tag implementing class (the one that extends TagRenderer).

Each TagSupport contains a Regular Expression on the name of the tag, using simple pattern like <%1$s[^>]*>(.*)</%1$s>. The Regular Expression identifies the tag XML-like pattern and allows the extraction of the body for further processing.

public String execute(String tagBody) {
    try {
        return clazz.newInstance().doTag(tagBody);
    } catch (IllegalAccessException | InstantiationException e) {
        throw new TagException(e);
    }
}

TagFactory Class

The TagFactory is a singleton that contains an array of TagSupport objects. This array represents all the tags configured in file toolkit.properties.

Method executeTags(String) iterates over each tag and applies its pattern to the String content passed as parameter. For each match of the tag pattern in the content, it calls the tag's execute(String) method passing as parameter the identified tag body.

The original tag is then replaced with the result of its execution.

public String executeTags(String content) {
    StringBuffer result = null;
    StringBuffer buffer = new StringBuffer(content);

    for (TagSupport tag : tags) {
        result = new StringBuffer();
        Matcher matcher = tag.getPattern().matcher(buffer);
        while (matcher.find()) {
            String tagBody = matcher.groupCount() > 0 ? matcher.group(1) : null;
            matcher.appendReplacement(result, tag.execute(tagBody));
        }
        matcher.appendTail(result);
        buffer = result;
    }

    return result == null ? content : result.toString();
}



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