Skip to main content

CWA Navigation Custom Tag

Image
By
Normally with Tridion, we do navigation as a transformation between a navigation XML with an XSLT stylesheet. We plug some parameters into this transformation in order to highlight the current context.

In CWA (Content Web Application) terms, this approach still applies only with some modification. Namely, the XML and XSLT are usually both published to the CD (Content Delivery) database. This setup implies that we need a special way or reading the XML/XSLT, prior to performing the actual transformation. To this respect, I created a custom Java tag CwaTransformXml that first ensures the XML and XSLT files are extracted from the CD DB and serialized as files on the file system, then second, it performs the XSLT transformation.

CwaTransformXml has the following attributes:
  • xml - the XML file path;
  • xslt - the XSLT file path;
  • paramName - the name of the parameter to pass into the transformation;
  • paramValue - the value of the parameter;
  • out - the variable name to set in PageContext holding the result of the transformation;

Moreover, the tag caches the XML DOM document and the XSLT Template into the application scope, such that they don't need be parsed and recreated with every tag call. Also the output of the transformation can be cached in the PageContext, such that it can be reused on the same page.

    <t:CwaTransformXml xml="/en/system/nav.xml" xslt="/en/system/main.xslt"
        paramName="CurrentPage" paramValue="tcm:2-3-64"/>

The main tag logic is the following:

public int doStartTag() throws JspException {
    try {
        Document xmlDom = (Document) CacheUtils.getFromCache(xml, pageContext, cache);
        DOMSource domSource = new DOMSource(xmlDom);
        Templates templates = (Templates) CacheUtils.getFromCache(xslt, pageContext, cache);

        Transformer transformer = templates.newTransformer();
        setParams(transformer);

        if (out == null) {
            transformer.transform(domSource, new StreamResult(pageContext.getOut()));
        } else {
            StringWriter writer = new StringWriter();
            transformer.transform(domSource, new StreamResult(writer));
            pageContext.setAttribute(out, writer.toString());
        }
    } catch (Exception e) {
        throw new JspException(e);
    }

    return SKIP_BODY;
}

The method CacheUtils.getFromCache() makes sure the path passed to it is retrieved from the CD DB and serialized to the file system (it is using CWA's class PageFileDistributionController), parses the XML DOM (or XSLT Templates object), places it into the application scope cache, then retrieves the actual DOM/Templates object.

public static Object getFromCache(String name, PageContext pageContext, long cache) {
    CacheEntry cacheEntry = (CacheEntry) pageContext.getAttribute(name,
        PageContext.APPLICATION_SCOPE);

    if (cacheEntry == null || System.currentTimeMillis() > cacheEntry.getTtl()) {
        cacheEntry = setInCache(name, cacheEntry, pageContext, cache);
    }

    return cacheEntry.getItem();
}

private static synchronized CacheEntry setInCache(String name, CacheEntry cacheEntry,
        PageContext pageContext, long cache) {
    long currentTimeMillis = System.currentTimeMillis();

    if (cacheEntry == null) {
        cacheEntry = new CacheEntry(0, null);
        pageContext.setAttribute(name, cacheEntry, PageContext.APPLICATION_SCOPE);
    }

    if (currentTimeMillis > cacheEntry.getTtl()) {
        PageFileDistributionController controller =
            PageFileDistributionController.getInstance();
        ServletContext servletContext = pageContext.getServletContext();
        HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();
        File file = controller.processPage(servletContext, request, name);

        String nameLower = name.toLowerCase();
        Object item = null;
        if (nameLower.endsWith(".xslt") || nameLower.endsWith(".xsl")) {
            Source source = new StreamSource(file);
            item = transformerFactory.newTemplates(source);
        } else if (name.endsWith(".xml")) {
            DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
            item = documentBuilder.parse(file);
        }

        cacheEntry.setTtl(currentTimeMillis + cache);
        cacheEntry.setItem(item);
    }

    return cacheEntry;
}

Where CacheEntry class is just a POJO holding the following members:

    private long ttl;
    private Object item;

Labels:

Comments

Post a Comment

Popular posts from this blog

Toolkit - Performance

By
This post if part of a series about the File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents performance data that was captured for each major functionality with and without caching Linking, CP Assembler, Component Presentation Factory, Dynamic Content Queries, Model Factory. The data was captured on a 2014 Macbook Pro 15", 16 GB RAM, 2.6 GHz Intel Core i7 running OS X El Capitan. Test methodology: each test was run for 3 minutes and the total number of successful Toolkit API calls was measured. Then the number of calls per second was computed 'with cache' and 'without cache' test runs. Then a cache boost factor was calculated by diving (the number of API calls with cache) / (number of API calls without cache). Each cache test was executed 3 times, with different cache time-to-live values of 1 second, 5 seconds and 0 seconds (eternal cache, no expiration). The rationale is to see what impact different cache expiration/evi...
Post a Comment
Read more

Running sp_updatestats on AWS RDS database

By
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...
2 comments
Read more

A Core Service Java Client

By Unknown
I have seen many times the creation of a .NET client for SDL Tridion's Core Service, but not once a Java client. In .NET / Visual Studio is extremely easy to create the proxy classes based on the service's WSDL. So how hard can it be in Java? The entire code in this example is available in my Google Code project . Which Tool? Doing a bit of research on the multiple ways of creating Java proxy classes for web services left me quite confused as to which framework / utility to use. They are quite a few (AXIS, JAXB, Apache CXF, XFire, NetBeans plugin, IDEA plugin, Eclipse plugin, etc). They seemed to be cumbersome to use, too specific, limited, quirky, buggy, etc. What I wanted was a simple generic too that worked. Enter wsimport.exe ... Generating the Proxies Note: Check out the update post available here  http://yatb.mitza.net/2012/12/java-core-service-trouble-with-datetime.html Wsimport.exe is part of the JDK (mine is located in C:\Progrm Files\Java\jdk1.6.0_33\bin ),...
3 comments
Read more