Using the Windows Azure Service Bus with SharePoint (part 2) - Create the Listener Service

Open Microsoft Visual Studio 2010 and click File | New and then Project. Select Windows in the installed templates directory, and then select Console Application.

Provide a name for your project (such as ListenerService), and click OK.

Right-click the project and select Add Reference. Add three libraries to the new project: Microsoft.SharePoint.dll, System.ServiceModel.dll, and Microsoft.ServiceBus.dll.

Right-click the project and select Properties. Click the Application tab and make sure that the Target framework (that is, the Microsoft .NET Framework) is set to .NET Framework 3.5. Also, click the Build tab and make sure that the Platform target is set to Any CPU.

Right-click the project and add a new class. Provide a name for the class (such as AddSharePointDataService) and click Add.

Amend the code in the newly added class as shown in the following bolded code:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using Microsoft.SharePoint;

namespace ListenerService
{
    [ServiceBehavior(Name = "SharePointService", Namespace =
"http://samples.microsoft.com/ServiceModel/Relay/")]
    public class AddSharePointDataService : IAddSharePointData
    {
        public string AddSharePointListItem(string contactName)
        {
            Console.WriteLine("Adding a record to SharePoint: {0}", contactName);
            using (SPSite mySiteCollection = new SPSite("http://blueyonderdemo/"))
            {
                using (SPWeb myWeb = mySiteCollection.OpenWeb())
                {
                    SPList myList = myWeb.Lists["Sales"];
                    SPListItem myListItem = myList.Items.Add();
                    myListItem["Title"] = "Acme";
                    myListItem["Contact"] = contactName;
                    myListItem["FY09"] = "$590,000.00";
                    myListItem["FY10"] = "$610,210.00";
                    myListItem["FY11"] = "$656,222.00";
                    myListItem.Update();
                }
            }
            return contactName + " and related sales data was added.";
        }
    }
}

The preceding code is the core code that integrates with SharePoint and is the processing code in your listener service. It will accept a contact name (contactName) as a parameter and then add that parameter along with some hard-coded data into a SharePoint list called Sales. You’ll note that you need to initially set the context for SharePoint with the using statements. When you’ve set up the context for the SharePoint site, you can then access the specific list by using the Lists property, and then programmatically add the hard-coded values and the single passed parameter by assigning values to the list item fields (that is, myListItem[“Title”]). You push the changes to the server by finally calling the Update method.

The code uses the SharePoint server object model because this service will live on the same server as the SharePoint site collection. You should note that if you’re trying to decide which way to integrate with SharePoint programmatically, the server object model performs well out of the APIs and web services natively available within SharePoint. However, if you intend to use the server object model, remember that your code must live on the SharePoint server, or you can use the SharePoint client object model for remote integration.

Right-click the project and select Add | New Item. Then select Interface from the list of available items. Make sure you call your interface IAddSharePointData. The following bolded code represents the service interface contract for the service you created in the previous step:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text;
using System.ServiceModel;

namespace ListenerService
{
    [ServiceContract(Name = "SharePointServiceContract", Namespace = "http://samples.
microsoft.com/ServiceModel/Relay/")]
    public interface IAddSharePointData
    {
        [OperationContract]
        string AddSharePointListItem(string contact);
    }
}

Double-click Program.cs and amend the class as shown in the following bolded code:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Description;
using Microsoft.ServiceBus;
using Microsoft.ServiceBus.Description;

namespace ListenerService
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.Title = "SharePoint Listening Service";

            Console.Write("Namespace Domain: ");
            string nsDmn = Console.ReadLine();
            Console.Write("Name: ");
            string issrName = Console.ReadLine();
            Console.Write("Secret: ");
            string issrSecret = Console.ReadLine();

            Uri address = ServiceBusEnvironment.CreateServiceUri("sb",
                          nsDmn, "SharePointService");

            TransportClientEndpointBehavior sharedCreds = new
                TransportClientEndpointBehavior();
            sharedCreds.CredentialType = TransportClientCredentialType.SharedSecret;
            sharedCreds.Credentials.SharedSecret.IssuerName = issrName;
            sharedCreds.Credentials.SharedSecret.IssuerSecret = issrSecret;
            try
             {

               ServiceHost svcHost = new ServiceHost(
                typeof(AddSharePointDataService), address);

                IEndpointBehavior svcRegSettings = new
                    ServiceRegistrySettings(DiscoveryType.Public);

                foreach (ServiceEndpoint svcEndpoint in
                    svcHost.Description.Endpoints)
                {
                    svcEndpoint.Behaviors.Add(sharedCreds);
                }

                svcHost.Open();

                Console.WriteLine("Service information: " + address);
                Console.WriteLine("Hit [Enter] to exit application...");
                Console.ReadLine();

                svcHost.Close();
              }
             catch (Exception e)
               {
                Console.Writline(e.ToString());
               }

        }
    }
}

In the Program.cs file, the preceding code manages the creation of the WCF service endpoint instance that calls out to the AppFabric service bus. To do this, the instance of the service requires three main things: the domain namespace of the service (nsDmn), the management key name (issrName), and the management key secret (issrSecret). Using these three items, you can create and communicate across the service bus by constructing a service URI programmatically, and then assigning the specific security credentials to that URI. You then use the ServiceHost object to create an instance of the service class you created earlier in the exercise (AddSharePointDataService). Setting the DiscoveryType.Public in the service makes the service publicly visible, after which you add the service endpoint (svcEndpoint) with the appropriate credentials. Finally, you can open the service, which waits for the service to be called. You then close the service out after the user clicks the Enter button.

Note that to get the three key variables, this console application prompts you to enter them. For your own testing purposes, you might hard-code these variables, because entering the secret key manually can be cumbersome.

The last step to complete this example is to add an app.config file with the service configuration information in it. To add the file, right-click the project and select Add | New Item. Select General, and then click Application Configuration. Name the project app.config and amend the config file as follows:

<?xml version="1.0"?>
<configuration>
  <system.serviceModel>
    <services>
      <service name="ListenerService.AddSharePointDataService">
        <endpoint contract="ListenerService.IAddSharePointData"
          binding="netTcpRelayBinding"/>
      </service>
    </services>
  </system.serviceModel>
  <startup>
<supportedRuntime version="v2.0.50727"/></startup>
</configuration>