How to add a web service reference in a DLL

Question

I'm creating a DLL with a reference to web services (I don't have the choice to do so) but I have to add web service references to the project that uses the DLL for it to work.

Example, I have the DLL called API.DLL that calls a web service called WebService.svc that I want to use in a project called WinForm. First, I have to add a "Service Reference" to WebService.svc in API.DLL. Then, I add a reference API.DLL to WinForm but it doesn't work unless I also add a service reference to WebService.svc in WinForm.

What can I do to avoid that last step?

Answer 1

Your first step is to prove to yourself that this is possible and then adapt your project.

you can download the runnable solution here.

I just went through the steps and enumerated my actions to produce the results you desire.

    Create a web app project (an thus a solution) named 'ReferencedWebService'
    Add a web service, just leave the default name and implementation
    Add a class library named 'ReferencedWebserviceAPI'
        Add Service Reference
            >Advanced
                >Add Web Reference>Web services in this solution
                    >WebService1
                        >Add reference leaving name as 'localhost'
    Add a console application project named 'ReferencedWebserviceClient'    
    To ReferencedWebserviceClient: 
        Add Reference
            >Projects
                >ReferencedWebserviceAPI
        Add Reference
            >.Net
                >System.Web.Services

    In Program.cs replace Main:

    static void Main(string[] args)
    {
        var svc = new ReferencedWebserviceAPI.localhost.WebService1();
        var result = svc.HelloWorld();
        Console.WriteLine(result);
        Console.ReadLine();
    }


    Set ReferencedWebserviceClient as startup project and run.

    Ok, this is simplest scenario. One issue you will have to deal with is that the default Service URL is hardcoded in the .dll,
    and it is set to a ported address on your dev machine.

    You will want to add a configuration parameter to your client project. The simplest and most portable way is to use an appSetting.

    To ReferencedWebserviceClient:
        Add Item
            >Application Configuration File

    Replace contents of App.Config with this, of course replace the value with the appropriate value on your machine.

    
    
      
        
      
    


        Add Reference
            >.Net
                >System.Configuration

    Now replace Main with this:

    static void Main(string[] args)
    {
        var svc = new ReferencedWebserviceAPI.localhost.WebService1
                      {
                          Url = ConfigurationManager.AppSettings["serviceUrl"]
                      };
        var result = svc.HelloWorld();
        Console.WriteLine(result);
        Console.ReadLine();
    }

This is the baseline for embedding services in a redistributable .dll.

Try to apply this model to your current project and see how that works for you.

If you still have problems, you most definitely have a reference issue and should start looking at it from that perspective.

Hope this helps

Answer 2

You may be using types exposed by the web service, or it may be that you are having to add the web reference so that appropriate connection information is added to the config file. A winform application will not inherit or use a DLL's config file in any way unless you were to cook up some fancy loading mechanism for it. In other words, in the DLL when you add a web reference, it's config file gets information about how to connect to the web service, but when you then use the DLL in an application, your application needs that info in it's own config file, thus you must add a web reference so that the information is generated.

In regards to using a type exposed by the web reference, I'm not sure if this could be an issue you are experiencing. I have encountered this kind of thing in DLLs. For example, SharpMap.dll declares a SharpMapData class, and WrapperOfSharpMap.dll has a method called ProcessData(SharpMapData blah)

If I write a WinForm application and add a reference to WrapperOfSharpMap.dll, I also have to add a reference to SharpMap.dll because to call ProcessData I have to create a SharpMapData instance to pass to the function. In other words, I am using a type declared in SharpMap.dll, therefore need a reference to it.

To resolve this problem, the creator of WrapperOfSharpMap.dll must create a WrapperSharpMapData class like so:

class WrapperSharpMapData
{
  private SharpMapData hiddenSharpMapData;

  //create proprerties to access data elements using standard CLR types or other wrapper types
}