Welcome!

Microsoft Cloud Authors: Nick Basinger, Kevin Benedict, Pat Romanski, Liz McMillan, Lori MacVittie

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)

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.


IoT & Smart Cities Stories
This month @nodexl announced that ServerlessSUMMIT & DevOpsSUMMIT own the world's top three most influential Kubernetes domains which are more influential than LinkedIn, Twitter, YouTube, Medium, Infoworld and Microsoft combined. NodeXL is a template for Microsoft® Excel® (2007, 2010, 2013 and 2016) on Windows (XP, Vista, 7, 8, 10) that lets you enter a network edge list into a workbook, click a button, see a network graph, and get a detailed summary report, all in the familiar environment of...
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
IT professionals are also embracing the reality of Serverless architectures, which are critical to developing and operating real-time applications and services. Serverless is particularly important as enterprises of all sizes develop and deploy Internet of Things (IoT) initiatives. Serverless and Kubernetes are great examples of continuous, rapid pace of change in enterprise IT. They also raise a number of critical issues and questions about employee training, development processes, and opera...
AI and machine learning disruption for Enterprises started happening in the areas such as IT operations management (ITOPs) and Cloud management and SaaS apps. In 2019 CIOs will see disruptive solutions for Cloud & Devops, AI/ML driven IT Ops and Cloud Ops. Customers want AI-driven multi-cloud operations for monitoring, detection, prevention of disruptions. Disruptions cause revenue loss, unhappy users, impacts brand reputation etc.
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
Atmosera delivers modern cloud services that maximize the advantages of cloud-based infrastructures. Offering private, hybrid, and public cloud solutions, Atmosera works closely with customers to engineer, deploy, and operate cloud architectures with advanced services that deliver strategic business outcomes. Atmosera's expertise simplifies the process of cloud transformation and our 20+ years of experience managing complex IT environments provides our customers with the confidence and trust tha...
The Japan External Trade Organization (JETRO) is a non-profit organization that provides business support services to companies expanding to Japan. With the support of JETRO's dedicated staff, clients can incorporate their business; receive visa, immigration, and HR support; find dedicated office space; identify local government subsidies; get tailored market studies; and more.
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
As you know, enterprise IT conversation over the past year have often centered upon the open-source Kubernetes container orchestration system. In fact, Kubernetes has emerged as the key technology -- and even primary platform -- of cloud migrations for a wide variety of organizations. Kubernetes is critical to forward-looking enterprises that continue to push their IT infrastructures toward maximum functionality, scalability, and flexibility. As they do so, IT professionals are also embr...
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...