Welcome!

Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

.NET Feature — Creating Custom WCF Behaviors

Apply cross-cutting logic to your services

Now that you've seen how to use an interceptor to create common logic (see Listing 1), and how to use a behavior to load that interceptor (see Listing 2), let's see how the behavior can be instructed to load via configuration files. You may first want to refer back to Listing 1 to see that the InsertLogging class inherits from the BehaviorExtensionElement class; this is the first thing you'll need to do if you want to use configured behaviors. When this is done, you must override that class's BehaviorType property and CreateBehavior method, as is shown in Listing 3.

The BehaviorType property in Listing 3 returns the type of behavior, which happens to be InsertLogging. CreateBehavior is a "creational method" that returns an instantiation of a new InsertLogging object. Altogether, this provides the configuration system the information it requires to load the behavior class at the appropriate time.

Let's move on to see what you'll need to put in your configuration files to associate a behavior with a specific service. The first part of the system.serviceModel section from web.config is presented in Listing 4.

The key thing to notice in Listing 4 is the behaviorConfiguration attribute. This tells the configuration system that a specific behavior, in this case one named LogBehavior, should be configured for use with this service. Listing 5 shows the behaviors section where you can see the actual definition for that behavior. Note that it has an element named LoggingBehavior, which indicates the "extension" to be associated with LogBehavior.

Listing 5 shows that the behaviorExtensions element contains a directive to add a custom .Net type named WCF.Behaviors.InsertLogging that can be found in the assembly named WCF.Behaviors. If you have set up your configuration file properly then the WCF runtime will acquire this information prior to opening the ServiceHost and will execute the logic found in Listing 3 and then the logic in Listing 2. If all has gone according to plan up to this point then when a message flows into any service endpoint, the common logging logic found in Listing 1 will be executed.

How To Inject Client Information into the SOAP Headers
Now let's see how we can use a client-side Message Inspector and a Contract Behavior so that we can track which applications use a given version of a contract. Let's say that we always want to enforce this behavior, so we decide to use attributes to tell the WCF runtime to always load the behavior on the client. Listing 6 shows a portion of a class named InsertClientInfo. Notice that it inherits from the Attribute class and also implements IClientMessageInspector and IContractBehavior.

In summary, the logic in Listing 6 creates a custom MessageHeader using the ClientInfo type (see Listing 9), and adds that header to the request message. This all occurs before that message is sent through the proxy's channel stack and over the wire to the service. To put this interceptor into the WCF runtime on the proxy side, we can create code in the ApplyClientBehavior method so that a reference to the InsertClientInfo class will be added into the MessageInspectors collection of the proxy's clientRuntime. This is shown in Listing 7.

Now we have to alter the client proxy code so the ApplyClientBehavior method will be invoked. To do this we can either edit the output file produced by Svcutil.exe, or if we use the Visual Studio IDE to add a service reference to a project, we can edit the .cs file that it adds. Listing 8 shows how an attribute may be added to the code for the client proxy.

In this case, I used Visual Studio to add the service reference; this is why you see information from the CodeDom. Since I want to capture client information for all calls to a given service contract, I have to know the name of either the service interface class or the class that implements this interface. Lucky for me, I happen to know that the interface is named IBargainAirService. To tell the WCF runtime that it should load a behavior, the IBargainAirService interface has been decorated with the [WCF.Behaviors.InsertClientInfo] attribute. By choosing to decorate the IBargainAirService interface with this attribute, the effect will be that all classes in the proxy that implement this interface will have this behavior applied to them. Now, whenever a client opens a channel factory out to the service, the logic in Listing 7 will be invoked, and when the client sends a message out to the endpoint that contains this contract, the code in Listing 6 will step in to intercept the call. Pretty cool, eh?

Conclusion
We've covered a lot of ground in this article, from the WCF architecture that supports extensibility, to a few code samples showing some of the possibilities. I hope that you can now see how this powerful feature may be tapped to apply cross-cutting logic to your services. Perhaps you've even caught a glimpse of the endless possibilities that lie beyond.

More Stories By Rob Daigneau

Rob Daigneau is the Director of Architecture for Monster.com, one of the most visited web sites in the world. Rob has over 18 years of experience designing and implementing enterprise-class applications for a broad array of industries from manufacturing, to financial services, to retail. He is also a frequent speaker at conferences such as VS Live! and DevTeach, and writes on a number of industry-related topics for .NET Developer's Journal as well as at www.DesignPatternsFor.Net

Comments (2) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
John Fitzpatrick 05/14/08 02:56:29 PM EDT

Great article. The step by step description was really helpful and made this complicated topic digestible.
Thanks

Sachin 11/13/07 10:41:34 PM EST

Hi,

I saw this article and i am very impressed by this message logging idea. If you can send me the sample code for the given article then i will try to inject the policy injection for tracing and exception handling in the WCF services using Application Block.

Regards,

Sachin

@ThingsExpo Stories
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
SYS-CON Events announced today that mruby Forum will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. mruby is the lightweight implementation of the Ruby language. We introduce mruby and the mruby IoT framework that enhances development productivity. For more information, visit http://forum.mruby.org/.
Digital transformation is changing the face of business. The IDC predicts that enterprises will commit to a massive new scale of digital transformation, to stake out leadership positions in the "digital transformation economy." Accordingly, attendees at the upcoming Cloud Expo | @ThingsExpo at the Santa Clara Convention Center in Santa Clara, CA, Oct 31-Nov 2, will find fresh new content in a new track called Enterprise Cloud & Digital Transformation.
Most technology leaders, contemporary and from the hardware era, are reshaping their businesses to do software. They hope to capture value from emerging technologies such as IoT, SDN, and AI. Ultimately, irrespective of the vertical, it is about deriving value from independent software applications participating in an ecosystem as one comprehensive solution. In his session at @ThingsExpo, Kausik Sridhar, founder and CTO of Pulzze Systems, will discuss how given the magnitude of today's applicati...
SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp emp...
In a recent survey, Sumo Logic surveyed 1,500 customers who employ cloud services such as Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). According to the survey, a quarter of the respondents have already deployed Docker containers and nearly as many (23 percent) are employing the AWS Lambda serverless computing framework. It’s clear: serverless is here to stay. The adoption does come with some needed changes, within both application development and operations. Tha...
SYS-CON Events announced today that Avere Systems, a leading provider of enterprise storage for the hybrid cloud, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere delivers a more modern architectural approach to storage that doesn't require the overprovisioning of storage capacity to achieve performance, overspending on expensive storage media for inactive data or the overbui...
SYS-CON Events announced today that Avere Systems, a leading provider of hybrid cloud enablement solutions, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere Systems was created by file systems experts determined to reinvent storage by changing the way enterprises thought about and bought storage resources. With decades of experience behind the company’s founders, Avere got its ...
Amazon is pursuing new markets and disrupting industries at an incredible pace. Almost every industry seems to be in its crosshairs. Companies and industries that once thought they were safe are now worried about being “Amazoned.”. The new watch word should be “Be afraid. Be very afraid.” In his session 21st Cloud Expo, Chris Kocher, a co-founder of Grey Heron, will address questions such as: What new areas is Amazon disrupting? How are they doing this? Where are they likely to go? What are th...
As hybrid cloud becomes the de-facto standard mode of operation for most enterprises, new challenges arise on how to efficiently and economically share data across environments. In his session at 21st Cloud Expo, Dr. Allon Cohen, VP of Product at Elastifile, will explore new techniques and best practices that help enterprise IT benefit from the advantages of hybrid cloud environments by enabling data availability for both legacy enterprise and cloud-native mission critical applications. By rev...
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, will discuss how they b...
SYS-CON Events announced today that SkyScale will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. SkyScale is a world-class provider of cloud-based, ultra-fast multi-GPU hardware platforms for lease to customers desiring the fastest performance available as a service anywhere in the world. SkyScale builds, configures, and manages dedicated systems strategically located in maximum-security...
High-velocity engineering teams are applying not only continuous delivery processes, but also lessons in experimentation from established leaders like Amazon, Netflix, and Facebook. These companies have made experimentation a foundation for their release processes, allowing them to try out major feature releases and redesigns within smaller groups before making them broadly available. In his session at 21st Cloud Expo, Brian Lucas, Senior Staff Engineer at Optimizely, will discuss how by using...
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
SYS-CON Events announced today that Daiya Industry will exhibit at the Japanese Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ruby Development Inc. builds new services in short period of time and provides a continuous support of those services based on Ruby on Rails. For more information, please visit https://github.com/RubyDevInc.
As businesses evolve, they need technology that is simple to help them succeed today and flexible enough to help them build for tomorrow. Chrome is fit for the workplace of the future — providing a secure, consistent user experience across a range of devices that can be used anywhere. In her session at 21st Cloud Expo, Vidya Nagarajan, a Senior Product Manager at Google, will take a look at various options as to how ChromeOS can be leveraged to interact with people on the devices, and formats th...
SYS-CON Events announced today that Yuasa System will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Yuasa System is introducing a multi-purpose endurance testing system for flexible displays, OLED devices, flexible substrates, flat cables, and films in smartphones, wearables, automobiles, and healthcare.
Organizations do not need a Big Data strategy; they need a business strategy that incorporates Big Data. Most organizations lack a road map for using Big Data to optimize key business processes, deliver a differentiated customer experience, or uncover new business opportunities. They do not understand what’s possible with respect to integrating Big Data into the business model.
Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities – ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups. As a result, many firms employ new business models that place enormous impor...
SYS-CON Events announced today that Taica will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Taica manufacturers Alpha-GEL brand silicone components and materials, which maintain outstanding performance over a wide temperature range -40C to +200C. For more information, visit http://www.taica.co.jp/english/.