WebServicesClientProtocol Class

  • Article

Specifies the class from which client proxies derive when using the Web Services Enhancements (WSE).

Namespace: Microsoft.Web.Services3
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim webServicesClientProtocol1 As New WebServicesClientProtocol()

Syntax

'Declaration
Public Class WebServicesClientProtocol
    Inherits SoapHttpClientProtocol

public class WebServicesClientProtocol : SoapHttpClientProtocol

public ref class WebServicesClientProtocol : SoapHttpClientProtocol

public class WebServicesClientProtocol extends SoapHttpClientProtocol

public class WebServicesClientProtocol extends SoapHttpClientProtocol

Remarks

When you build an XML Web service client, whether you use Visual Studio or not, a proxy class is generated to communicate with the XML Web service. When you are using Visual Studio, that proxy class is generated when a Web reference is made or updated. If the .NET Framework SDK is used without Visual Studio, the proxy class is generated using the Web Services Description Language tool (Wsdl.exe). Either way, the proxy class derives from SoapHttpClientProtocol by default. To use the functionality of the WSE, change the class that the proxy class derives from to WebServicesClientProtocol.

This class provides access to the SoapContext for both SOAP requests and SOAP responses for XML Web service clients with the RequestSoapContext and ResponseSoapContext properties respectively. This SoapContext provides access to the contents of SOAP headers that are defined in the WS-Security and WS-Addressing specifications.

If an instance of the WebServicesClientProtocol is cast or converted to SoapHttpClientProtocol, then the values of all properties of this class that are not members of the SoapHttpClientProtocol are lost. This includes the RequestSoapContext and ResponseSoapContext properties.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
       System.Web.Services.Protocols.WebClientProtocol
         System.Web.Services.Protocols.HttpWebClientProtocol
           System.Web.Services.Protocols.SoapHttpClientProtocol
            Microsoft.Web.Services3.WebServicesClientProtocol

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

See Also

Reference

WebServicesClientProtocol Members
Microsoft.Web.Services3 Namespace
SoapContext