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.

 

Comments

  1. Replies
    1. Thank you for excellent article.You made an article that is interesting.
      Tavera car for rent in coimbatore|Indica car for rent in coimbatore|innova car for rent in coimbatore|mini bus for rent in coimbatore|tempo traveller for rent in coimbatore|kodaikanal tour package from chennai

      Keep on the good work and write more article like this...

      Great work !!!!Congratulations for this blog

      Delete
  2. This is very good blog for learners, Thanks for sharing valuable content on MSBI Online Training

    ReplyDelete
  3. I have to voice my passion for your kindness giving support to those people that should have guidance on this important matter.

    AWS Training in Bangalore

    ReplyDelete
  4. Really Thanks For Posting Such a Useful Content. Really Thanks For Sharing Such an Informative Post.
    USMLE

    ReplyDelete
  5. This Blog Provides Very Useful and Important Information Digital Transformation Consulting Thanks for sharing.

    ReplyDelete
  6. Thank you so much for your information,its very useful and helful to me.Keep updating and sharing. Thank you.
    RPA training in chennai | UiPath training in chennai

    ReplyDelete
  7. I wondered upon your blog and wanted to say that I have really enjoyed reading your blog posts. Any way I’ll be subscribing to your feed and I hope you post again soon.
    Web Designing Course in chennai
    Web Designing training in chennai
    Hadoop Training in Chennai
    Python Training in Chennai
    Web designing Training in Porur
    Web designing Training in Adyar
    Web designing Training in Tnagar

    ReplyDelete
  8. Are you currently scratching your head and stuck together with your QuickBooks related issues, you'll be only one click definately not our expert tech support team for your QuickBooks Support Phone Number related issues.

    ReplyDelete

Post a Comment

Popular posts from this blog

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\TempDelete all EventViewer logs Save to another Disk if you want to keep themRemove any unused programs, e.g. FirefoxRemove anything in C:\inetpub\logsRemove any file/folders C:\Windows\System32\LogFilesRemove any file/folders from C:\Users\%UserName%\DownloadsRemove any file/folders able to be removed from C:\Users\%UserName%\DesktopRemove any file/folders able to be removed from C:\Users\%UserName%\My DocumentsStop Windows Update service and remove all files/folders from C:\Windows\SoftwareDistributionDeleting 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 cleared by using the Disk Cleanup to…

CPF Contribution Rates for new Singapore Permanent Residents (SPR’s)

Recently my wife and I applied and got approved for Singapore Permanent Residency. After completing the formalities the most significant immediate change is the contribution to CPF which is Singapore’s mandatory social security savings scheme requiring contributions from employers and employees. CPF contributions start from the date you obtain SPR status, which is the date of the entry permit.   Being a relentless budgeter I needed to know exactly how much I and my employer would have to contribute so that I could adjust my budget accordingly as the employee contributions get deducted from the monthly salary. After doing some research I discovered that there is a “graduated” approach to CPF contributions for new SPR’s where the contributions gradually increase in the first and second year and then upon reaching the third year are at the full amount. Note: There is an option for employers to contribute the full amount for year 1 and year 2 and the employee can use the graduated rate, b…