Skip to main content

Implementing Custom Castle Windsor Facilities

 

If you’ve been following my posts you would know that I love Castle Windsor.

One of the many useful features I have found is the Facility and I’m going to try and give a good example how you can make use of this.

In a recent post I showed how you can add Cross-Cutting concerns to your application by using Interceptors.

Now when configuring the Container you can explicitly configure each Interceptor per Service but when you have lot’s of components it can get pretty hard to maintain after a while and can also introduce subtle issues if someone forgets to configure it correctly.

 

Below is how you would configure your Container without using a Facility. On the last line we are specifying the Interceptor explicitly.

        public void Configure()
        {
            container = new WindsorContainer();

            container.Register(
                Component.For<CacheInterceptor>(),
                Component.For<ICacheProvider>()
                    .ImplementedBy<WebCacheProvider>().LifeStyle.Singleton,
                Component.For<ICatalogQueryService>()
                    .ImplementedBy<CatalogQueryService>()
                    .LifeStyle.Transient
                    .Interceptors(new InterceptorReference(typeof (CacheInterceptor))).Anywhere);
        }

Or the XML version

<?xml version="1.0" encoding="utf-8" ?>
<castle>
  <components>
    <component id="CacheInterceptor"
             service="MyApp.Aop.CacheInterceptor, MyApp"
             type="MyApp.Aop.CacheInterceptor, MyApp"
             lifestyle="transient">
    </component>
    <component id="ICatalogQueryService"
             service="MyApp.Services.ICatalogQueryService, MyApp"
             type="MyApp.Services.Impl.CatalogQueryService, MyApp"
             lifestyle="transient">
      <interceptors>
        <interceptor>${CacheInterceptor}</interceptor>
      </interceptors>
    </component>
    <component id="ICacheProvider"
             service="MyApp.Core.Cache.ICacheProvider, MyApp"
             type="MyApp.Core.Cache.Impl.WebCacheProvider, MyApp"
             lifestyle="transient">
    </component>
  </components>
</castle>

What would be nice would be to be able to specify the Interceptor on all Components automagically and Castle allows for this with Facilities. Below is an implementation which achieves the desired result.

   public class CacheInterceptionFacility : AbstractFacility
   {
       protected override void Init()
       {
           Kernel.ComponentRegistered += Kernel_ComponentRegistered;
       }

       private void Kernel_ComponentRegistered(string key, IHandler handler)
       {
           if (typeof(IMustBeCached).IsAssignableFrom(handler.ComponentModel.Implementation))
           {
               handler.ComponentModel.Interceptors
                   .Add(new InterceptorReference(typeof(CacheInterceptor)));
           }
       }
   }

All you have to do is Inherit from the Castle.MicroKernel.Facilities.AbstractFacility and then override the Init.

You’ll see that we use the Interface IMustBeCached to identify the Component to apply the Interceptor too.

Now in your Bootstrapper all you have to do is call AddFacility on the WindsorContainer and you’re good to go.

        public void Configure()
        {
            container = new WindsorContainer();

            container.Register(
                Component.For<CacheInterceptor>(),
                Component.For<ICacheProvider>()
                    .ImplementedBy<WebCacheProvider>().LifeStyle.Singleton,
                Component.For<ICatalogQueryService>()
                    .ImplementedBy<CatalogQueryService>().LifeStyle.Transient);

            container.AddFacility("CacheInterceptionFacility", new CacheInterceptionFacility()); 

        }

Or the XML version

<?xml version="1.0" encoding="utf-8" ?>
<castle>
  <facilities>
    <facility
      id="CacheInterceptionFacility"
      type="MyApp.Aop.CacheInterceptionFacility, MyApp">
    </facility>
  </facilities>
  <components>
    <component id="CacheInterceptor"
             service="MyApp.Aop.CacheInterceptor, MyApp"
             type="MyApp.Aop.CacheInterceptor, MyApp"
             lifestyle="transient">
    </component>
    <component id="ICatalogQueryService"
             service="MyApp.Services.ICatalogQueryService, MyApp"
             type="MyApp.Services.Impl.CatalogQueryService, MyApp"
             lifestyle="transient">
    </component>
    <component id="ICacheProvider"
             service="MyApp.Core.Cache.ICacheProvider, MyApp"
             type="MyApp.Core.Cache.Impl.WebCacheProvider, MyApp"
             lifestyle="transient">
    </component>
  </components>
</castle>

 

Aside from reducing the configuration overhead another benefit of using this approach is that in your Debug or Test Environments you can easily deploy without any Interceptors and only enable them in your Staging and Production environments.

 

Popular posts from this blog

ASP.NET MVC Release Candidate - Upgrade issues - Spec#

First of all, great news that the ASP.NET MVC Release Candidate has finally been released.  Full credit to the team for the hard work on this.  You can get the download here  However this is the first time I have had upgrade issues.  Phil Haack has noted some of the issues here   If like me you have lot's of CTP's and Add-Ins then you might experience some pain in Uninstalling MVC Beta on Vista SP1  This is the list of Add-Ins / CTP's I had to uninstall to get it to work  Spec# PEX Resharper 4.1  Sourcelinks ANTS Profiler 4   Can't say I'm too impressed as it wasted over an hour of my time.  As it turned out Spec# turned out to be the offending culprit, it's forgiveable to have issues with a third party product but a Microsoft one? Guess no-one on the ASP.NET team has Spec# installed. 

Freeing Disk Space on C:\ Windows Server 2008

  I just spent the last little while trying to clear space on our servers in order to install .NET 4.5 . Decided to post so my future self can find the information when I next have to do this. I performed all the usual tasks: Deleting any files/folders from C:\windows\temp and C:\Users\%UserName%\AppData\Local\Temp Delete all EventViewer logs Save to another Disk if you want to keep them Remove any unused programs, e.g. Firefox Remove anything in C:\inetpub\logs Remove any file/folders C:\Windows\System32\LogFiles Remove any file/folders from C:\Users\%UserName%\Downloads Remove any file/folders able to be removed from C:\Users\%UserName%\Desktop Remove any file/folders able to be removed from C:\Users\%UserName%\My Documents Stop Windows Update service and remove all files/folders from C:\Windows\SoftwareDistribution Deleting an Event Logs Run COMPCLN.exe Move the Virtual Memory file to another disk However this wasn’t enough & I found the most space was

Consuming the SSRS ReportExecutionService from a .NET Client

  I’ve just finished writing a nice wrapper which internally calls the SSRS ReportExecutionService to generate reports. Whilst it was fairly simple to implement there has been some major changes between 2005 and 2008 and the majority of online and documentation is based on the 2005 implementation. The most important change is that the Report Server and Report Manager are no longer hosted in IIS which will be a welcomed change to Sys Admins but makes the security model and hosting model vastly different. So far I’ve yet to figure out how to allow Anonymous Access, if anyone knows how to do this leave a comment and it will be most appreciated. Getting Started To get started you’ll want to add a service reference to http://localhost/ReportServer_SQL2008/ReportExecution2005.asmx where ReportServer_SQL2008 is the name you configure in the Reporting Services Configuration Manager. The Web Application files are located in C:\Program Files\Microsoft SQL Server\MSRS10.SQL2008\R