Skip to main content

Toolkit - Examples

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

This post describes a few examples of Toolkit API.

Model Factory

The following example retrieves a Page model and a Component model.

ModelFactory modelFactory = ModelFactory.INSTANCE;

TcmUri tcmUri = new TcmUri(6, 1225, 64);
PageMeta model = modelFactory.getModel(tcmUri);

tcmUri = new TcmUri(6, 52);
ComponentMeta componentMeta = modelFactory.getModel(tcmUri);

Link Resolving

The following examples resolve Binary, Component and Page links.

LinkFactory linkFactory = LinkFactory.INSTANCE;

Link link = linkFactory.getBinaryLink(6, 84);
if (link.isResolved()) {
    String url = link.getUrl();

// link to a Component
link = linkFactory.getComponentLink(6, 52);
// link to a Component from a Page
link = linkFactory.getComponentLink(6, 1138, 1118);
// link to a Page
link = linkFactory.getPageLink(6, 55);

Component Presentation Factory

The following example retrieves a Component Presentation by ids but also using highest linking priority.

ComponentPresentationFactory factory = ComponentPresentationFactory.INSTANCE;

ComponentPresentationMeta dcpMeta =
        factory.getComponentPresentationWithHighestPriority(6, 1151);
if (dcpMeta != null) {
    // unresolved content
    String content = dcpMeta.getContent();

dcpMeta = factory.getComponentPresentation(6, 52, 1117);

Component Presentation Assembler

The following example shows a returns the resolved Component Presentation content. If there are any tags in the content, they are resolved.

ComponentPresentationAssembler assembler = ComponentPresentationAssembler.INSTANCE;

String content = assembler.getContent(6, 1151, 1117);

Tag Handling

The following snippet executes tags found in the content. It replaces them with the actual output from the tags.

TagFactory tagFactory = TagFactory.INSTANCE;

String content = tagFactory.executeTags("some <mytag>quick brown fox</mytag> content");

The example above must backed by (1) the following tags definition in file:

and (2) the tag class implementation, for example:

package some.tag.example;

import com.mitza.toolkit.dynamic.TagRenderer;

public class MyTag implements TagRenderer {

    public String doTag(String tagBody) {
        // do actual processing here

        return tagBody == null ? null : tagBody.toUpperCase();

The result content of the code above will be:

content = "some QUICK BROWN FOX content"

Dynamic Query

Example 1:
Simple query on Publication Id, Custom Meta that retrieves ComponentMeta models:

Criterion criterion = new AndCriteria(
        new CustomMetaCriterion("Type", "Article"),
        new PublicationCriterion(13)

Query query = new Query(criterion);
List<ComponentMeta> componentMetas = query.executeComponentQuery();

Example 2:
Complex criteria using date range, Publication Id, Custom Meta that retrieves Page meta models. The following query retrieves PageMeta models from either publication 6 or 8 that have CustomMeta 'ReleaseDate' in a certain period of time AND that have CustomMeta 'Type' either 'Article' or 'News':

Criterion criterion = new AndCriteria(
                new OrCriteria(
                        new PublicationCriterion(6),
                        new PublicationCriterion(8)
                new CustomMetaCriterion("ReleaseDate", new Date(1450673126000L), new Date(1550673206000L), false),
                new OrCriteria(
                        new CustomMetaCriterion("Type", "Article"),
                        new CustomMetaCriterion("Type", "News")
Query query = new Query(criterion);
List<PageMeta> pageMetas = query.executePageQuery();

Example 3:
Pagination and Sorting example:

Criterion criterion = new CustomMetaCriterion("String", "LOLEK2");
Query query = new Query(criterion);
query.addSort("Type", SortDirection.ASCENDING);
query.addSort(SortColumn.LAST_PUBLISH, SortDirection.DESCENDING);

List<String> uris = query.executeQuery();


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: I stumbled upon the following post from 2008 (!!!), , 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