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 toolkit.properties file:

tag.name.1=mytag
tag.class.1=some.tag.example.MyTag

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(
        Arrays.asList(
                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);
query.setPage(2);
query.setPageSize(25);

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



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