Skip to main content

A DD4T.net Implementation - Navigation (part 2)

In previous post, Navigation, I presented the foundation for deserializing the navigation XML into an object model. In this post, I'll continue presenting the NavigationFactory class and the integration with caching.

The NavigationFactory class is a singleton wired through dependency injection (such as Ninject) that uses caching to serve navigation object model for a given Publication.

[Inject]
public virtual ICacheWrapper CacheWrapper { get; set; }

public Navigation GetNavigation()
{
    string publicationUrl = UriHelper.GetPublicationUrl(HttpContext.Current);
    string key = GetKey(publicationUrl);

    Navigation navigation;
    object cacheElement;
    if (!CacheWrapper.TryGet(key, out cacheElement))
    {
        string virtualPath = publicationUrl + "system/navigation.xml";
        string filePath = HttpContext.Current.Request.MapPath(virtualPath);
        navigation = ParseXml<Navigation>(filePath);
        SetParent(navigation);

        if (navigation == null)
        {
            CacheWrapper.Insert(key, false, 1);
        }
        else
        {
            CacheWrapper.Insert(key, navigation, 60);
        }
    }
    else
    {
        navigation = cacheElement as Navigation;
    }

    return navigation;
}

Notice the following:
  • The returned navigation object model depends on the Publication identified for the current request. They method GetPublicationUrl from class UriHelper returns the first level folder of the URL path, which helps us identify the Publication;
  • Method ParseXml was presented in my previous post, mentioned above, and is in charge with deserializing the XML into an object model;
  • A null Navigation object is cached for one minute, just to make performance better, in case the navigation XML is somehow missing or not deserializeable; otherwise, the navigation object is cached for one hour;
  • For simplicity sake of this example, the code uses hard-coded values for cache times and the XML navigation path is "/system/navigation.xml" under the PublicationUrl;
  • Method SetParent is used to create the reference from child navigation item to its parent. Initially, the navigation XML contains only information about parent navigation item to its children, but in practice we also need the capability to traverse the navigation model upward;

private void SetParent(Navigation navigation)
{
    if (navigation == null)
    {
        return;
    }

    foreach (NavigationItem item in navigation.Items)
    {
        SetParent(item);
    }
}

private void SetParent(NavigationItem item)
{
    if (item == null || item.ChildItems == null)
    {
        return;
    }

    foreach (NavigationItem child in item.ChildItems)
    {
        child.ParentItem = item;
        SetParent(child);
    }
}

A useful method is GetNavigation(Navigation object) which gives us an array of NavigationItem objects situated under the 'root' Structure Group in the navigation model.

public NavigationItem[] GetNavigation(Navigation navigation)
{
    if (navigation == null || navigation.Items.IsNullOrEmpty())
    {
        return new NavigationItem[0];
    }

    NavigationItem[] childItems = navigation.Items[0].ChildItems;

    return childItems == null ? new NavigationItem[0] : childItems;
}

The code above is wired in Ninject using the following construct:

Bind<INavigationFactory>().To<NavigationFactory>().InSingletonScope();

Also, client code make use of the navigation using the following constructs:

INavigationFactory factory = DependencyResolver.Current.GetService<INavigationFactory>();
Navigation navigation = factory.GetNavigation();
NavigationItem[] items = factory.GetNavigation(navigation);


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