Home > Development > Call REST services from BizTalk Server 2010

Call REST services from BizTalk Server 2010

I was having some trouble consuming REST services from Biztalk Server 2010.

The first and easy thing to try is creating a Send Port with WCF-Custom adapter and configuring webHttpBinding as the binding and webHttpBehavior as the behavior.

But it doesn’t work inmediately, when you send a message with this configuration, you’ll get the following error:

The adapter failed to transmit message going to send port "SampleSendPort" with URL "http://localhost/SampleSite". It will be retransmitted after the retry interval specified for this Send Port. Details:"System.InvalidOperationException: Manual addressing is enabled on this factory, so all messages sent must be pre-addressed."

So, I tried another solution that I read around, use webHttpBehavior but instead of webHttpBinding, use a custom binding just like webHttpBinding but with manual addressing turned off. This looks like this:

The problem is that webHttpBehavior expects ManualAddressing to be turned on, so it throws this error:

The adapter failed to transmit message going to send port "SampleSendPort" with URL "http://localhost/SampleSite". It will be retransmitted after the retry interval specified for this Send Port. Details:"System.InvalidOperationException: In the endpoint at 'http://localhost/SampleSite', in order to use 'System.ServiceModel.Description.WebHttpBehavior', the 'HttpTransportBindingElement' of the binding must have ManualAddressing set to true."

So, I got rid of webHttpBehavior, and the messages were being sent without issues. If the endpoint couldn’t be reached, it would throw an error correctly in Biztalk and the message instance would get suspended. But when the server threw a 500 error (Internal Server Error), the message would dissappear and no error would show up.

Finally I decided to use webHttpBinding, webHttpBehavior but also add a custom behavior that configures the address and the method for the call. I took the code for this from here: http://social.msdn.microsoft.com/Forums/eu/biztalkesb/thread/c19d7486-0705-433f-8e1a-a9088d076ed7. And it ends up looking like this:

WebManualAddressingBehavior.cs:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel.Description;
using System.ServiceModel.Dispatcher;
using System.ServiceModel.Channels;
using System.ServiceModel;
using System.ServiceModel.Configuration;
using System.Configuration;

namespace Logue.Library.WebManualAddressingBehavior
{
    public class WebManualAddressingBehavior : IEndpointBehavior, IClientMessageInspector
    {
        public string Method { get; set; }
        public Uri ManualAddress { get; set; }

        public WebManualAddressingBehavior()
        {
        }

        public WebManualAddressingBehavior(string _method, Uri manualAddress)
        {
            Method = _method;
            ManualAddress = manualAddress;
        }

        public void AddBindingParameters(ServiceEndpoint endpoint, System.ServiceModel.Channels.BindingParameterCollection bindingParameters)
        {
        }

        public void ApplyClientBehavior(ServiceEndpoint endpoint, System.ServiceModel.Dispatcher.ClientRuntime clientRuntime)
        {
            clientRuntime.MessageInspectors.Add(this);
        }

        public void ApplyDispatchBehavior(ServiceEndpoint endpoint, System.ServiceModel.Dispatcher.EndpointDispatcher endpointDispatcher)
        {
        }

        public void Validate(ServiceEndpoint endpoint)
        {
        }

        public void AfterReceiveReply(ref Message reply, object correlationState)
        {
        }

        public object BeforeSendRequest(ref Message request, IClientChannel channel)
        {
            request.Headers.To = ManualAddress;
            HttpRequestMessageProperty property = new HttpRequestMessageProperty();
            property.Method = Method;
            property.SuppressEntityBody = true;
            request.Properties.Add(HttpRequestMessageProperty.Name, property);

            return request;
        }
    }
}

WebManualAddressingBehaviorExtensionElement.cs:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel.Description;
using System.ServiceModel.Dispatcher;
using System.ServiceModel.Channels;
using System.ServiceModel;
using System.ServiceModel.Configuration;
using System.Configuration;

namespace Logue.Library.WebManualAddressingBehavior
{
    public class WebManualAddressingBehaviorExtensionElement : BehaviorExtensionElement
    {
        //Constructor to create instance of endpoint behavior and initialize with two property values.
        protected override object CreateBehavior()
        {
            return new WebManualAddressingBehavior(Method, ManualAddress);
        }

        public override Type BehaviorType
        {
            //Return configuration element type to be used in the behavior.
            get
            {
                return typeof(WebManualAddressingBehavior);
            }
        }

        [ConfigurationProperty("Method", DefaultValue = "GET", IsRequired = true)]
        public string Method
        {
            get
            {
                return (string)base["Method"];
            }
            set { base["Method"] = value; }
        }

        [ConfigurationProperty("ManualAddress", DefaultValue = "", IsRequired = true)]
        public Uri ManualAddress
        {
            get
            {
                return (Uri)base["ManualAddress"];
            }
            set { base["ManualAddress"] = value; }
        }

        //Copies the content of the specified configuration element to this configuration element
        public override void CopyFrom(ServiceModelExtensionElement extFrom)
        {
            base.CopyFrom(extFrom);
            WebManualAddressingBehaviorExtensionElement element = (WebManualAddressingBehaviorExtensionElement)extFrom;
            Method = element.Method;
        }

        //Represents a collection of configuration-element properties
        private ConfigurationPropertyCollection _properties;

        /// Both properties are returned as a collection.
        protected override ConfigurationPropertyCollection Properties
        {
            get
            {
                if (_properties == null)
                {
                    _properties = new ConfigurationPropertyCollection();
                    _properties.Add(new ConfigurationProperty("Method", typeof(string), "", ConfigurationPropertyOptions.IsRequired));
                    _properties.Add(new ConfigurationProperty("ManualAddress", typeof(Uri), "", ConfigurationPropertyOptions.IsRequired));
                }
                return _properties;
            }
        }
    }
}

You need to GAC this behavior assembly and modify both 32-bit and 64-bit machine.configs, in the following paths: “%WINDIR%Microsoft.NETFrameworkv4.0.30319Configmachine.config” and “%WINDIR%Microsoft.NETFramework64v4.0.30319Configmachine.config”.

In the system.serviceModel/extensions/behaviorExtensions section, add the following line:

<add name="webManualAddressingBehavior" type="Logue.Library.WebManualAddressingBehavior.WebManualAddressingBehaviorExtensionElement, Logue.Library.WebManualAddressingBehavior, Version=1.0.0.0, Culture=neutral, PublicKeyToken=be30eb01119b89a8" />

It should look like this:

And then, you should be able to add it to the send port configuration, so you can set the method and the address:

When configured like this, an error on server side will generate an exception on Biztalk send port as expected, like this:

The adapter failed to transmit message going to send port "SampleSendPort" with URL "http://localhost/SampleSite". It will be retransmitted after the retry interval specified for this Send Port. Details:"System.ServiceModel.CommunicationException: Internal Server Error

Downloads:
WebManualAddressingBehavior Source Code (249)
WebManualAddressingBehavior Binaries (180)

VN:F [1.9.11_1134]
Rating: 3.7/5 (3 votes cast)
Call REST services from BizTalk Server 2010, 3.7 out of 5 based on 3 ratings
Categories: Development Tags: , ,
  1. March 29, 2011 9:42 AM | #1

    I fixed the Registering at config file. Now I am not getting any error however the Zero Size message been sent to destination. Any idea what is wrong with configuration?

    VA:F [1.9.11_1134]
    Rating: +1 (from 1 vote)
    • March 31, 2011 10:42 AM | #2

      Can you give me more detail on how you are trying to send the message? You are getting an empty message at the destination if I understand correctly, right?

      VN:F [1.9.11_1134]
      Rating: 0 (from 0 votes)
  2. Harsh
    September 8, 2011 11:42 AM | #3

    I Think Null message is posted on service ..i am getting this at subscriber end on message trace.

    System.ServiceModel.Channels.NullMessage

    VA:F [1.9.11_1134]
    Rating: 0 (from 0 votes)
  3. Rajesh Gorla
    September 8, 2011 1:39 PM | #4

    Alter code to the below in WebManualAddressingBehavior.cs file

    public object BeforeSendRequest(ref Message request, IClientChannel channel)
    {
    request.Headers.To = ManualAddress;
    HttpRequestMessageProperty property = new HttpRequestMessageProperty();
    property.Method = Method;
    //property.SuppressEntityBody = true; take this line off..it should work
    request.Properties.Add(HttpRequestMessageProperty.Name, property);

    return request;
    }

    VA:F [1.9.11_1134]
    Rating: 0 (from 0 votes)
  4. LeandroDG
    September 8, 2011 1:51 PM | #5

    @Rajesh Gorla
    Cool, so this fixes the error file you mentioned? Thanks for the update :)

    VN:F [1.9.11_1134]
    Rating: 0 (from 0 votes)
  5. Sai
    November 1, 2012 6:33 PM | #6

    Now I am getting “System.ServiceModel.ProtocolException: Content Type application/xml; charset=utf-8 was not supported by service” any ideas how to fix this one.

    VA:F [1.9.11_1134]
    Rating: 0 (from 0 votes)
  6. Sai
    November 2, 2012 12:33 PM | #7

    Never mind i was using default message version in binding, i change it to Soap11 and working fine. Thank you so much.

    VA:F [1.9.11_1134]
    Rating: 0 (from 0 votes)
  1. No trackbacks yet.