Skip to main content

A DD4T.net Implementation - A Component Factory that Caches

A DD4T ComponentFactory is in charge of retrieving or searching for IComponent models by using either serving them from local cache or delegating the call to a ComponentProvider that uses the Tridion Broker API to look things up in the Content Delivery database.

When retrieving Component models, the ComponentFactory uses a couple of methods that take as parameters the TcmUri of the Component and a Component Template TcmUri.

    IComponent GetComponent(string componentUri, string templateUri = "");
    bool TryGetComponent(string componentUri, out IComponent component, string templateUri = "");


The default ComponentFactory from DD4T .net v1.31 has been written in a relaxed fashion, and don't enforce a mandatory Component Template TcmUri. If a lazy developer chooses not to pass a templateUri, the code still works. However, the call to the Content Delivery database is not cached. This results in performance degradation when the internal DD4T cache is expired, and a new call to a previously retrieved Component is made. The request will make all its way to the database.

This issue can easily be prevented by passing a Component Template TcmUri to these two methods. However, developers being lazy people, I want to enforce the second parameter to be passed and to have a valid TcmUri in it.

As such, I created my own CachingComponentFactory class as a specialization of the DD4T default ComponentFactory, where I overrode the two methods:

    public class CachingComponentFactory : ComponentFactory, IComponentFactory
    {
        public new IComponent GetComponent(string componentUri, string templateUri)
        {
            if (!UriHelper.IsValidTcmUri(templateUri))
            {
                throw new ComponentNotFoundException();
            }

            return base.GetComponent(componentUri, templateUri);
        }

        public new bool TryGetComponent(string componentUri, out IComponent component, string templateUri)
        {
            if (!UriHelper.IsValidTcmUri(templateUri))
            {
                component = null;
                return false;
            }

            return base.TryGetComponent(componentUri, out component, templateUri);
        }
    }


The code is very straight forward and expects the second TcmUri parameter to be passed and to be a valid TcmUri. Anything else results is a ComponentNotFoundException.

The only thing left to do is to wire up my CachingComponentFactory in Ninject so that it is used every time an IComponentFactory instance is requested.

    Bind<IComponentFactory>().To<CachingComponentFactory>().InSingletonScope();



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

REL Standard Tag Library

The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...

Publish Binaries to Mapped Structure Groups

Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...