HttpWebClientProtocol Class (System.Web.Services.Protocols)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
HttpWebClientProtocol Class

The base class for all XML Web service client proxies that use the HTTP transport protocol.

Inheritance Hierarchy
System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Web.Services.Protocols.WebClientProtocol
        System.Web.Services.Protocols.HttpWebClientProtocol
          System.Web.Services.Discovery.DiscoveryClientProtocol
          System.Web.Services.Protocols.HttpSimpleClientProtocol
          System.Web.Services.Protocols.SoapHttpClientProtocol

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax
Visual Basic
<ComVisibleAttribute(True)> _
Public MustInherit Class HttpWebClientProtocol _
	Inherits WebClientProtocol
C#
[ComVisibleAttribute(true)]
public abstract class HttpWebClientProtocol : WebClientProtocol
Visual C++
[ComVisibleAttribute(true)]
public ref class HttpWebClientProtocol abstract : public WebClientProtocol
F#
[<AbstractClass>]
[<ComVisibleAttribute(true)>]
type HttpWebClientProtocol =  
    class
        inherit WebClientProtocol
    end

The HttpWebClientProtocol type exposes the following members.

Constructors
  Name Description
Protected method HttpWebClientProtocol Initializes a new instance of the HttpWebClientProtocol class.
Top
Properties
  Name Description
Public property AllowAutoRedirect Gets or sets whether the client automatically follows server redirects.
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property ClientCertificates Gets the collection of client certificates.
Public property ConnectionGroupName Gets or sets the name of the connection group for the request. (Inherited from WebClientProtocol.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property CookieContainer Gets or sets the collection of cookies.
Public property Credentials Gets or sets security credentials for XML Web service client authentication. (Inherited from WebClientProtocol.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property EnableDecompression Gets or sets a Boolean that indicates whether decompression is enabled for this HttpWebClientProtocol.
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property PreAuthenticate Gets or sets whether pre-authentication is enabled. (Inherited from WebClientProtocol.)
Public property Proxy Gets or sets proxy information for making an XML Web service request through a firewall.
Public property RequestEncoding The Encoding used to make the client request to the XML Web service. (Inherited from WebClientProtocol.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property Timeout Indicates the time an XML Web service client waits for the reply to a synchronous XML Web service request to arrive (in milliseconds). (Inherited from WebClientProtocol.)
Public property UnsafeAuthenticatedConnectionSharing Gets or sets a value that indicates whether connection sharing is enabled when the client uses NTLM authentication to connect to the Web server that hosts the XML Web service.
Public property Url Gets or sets the base URL of the XML Web service the client is requesting. (Inherited from WebClientProtocol.)
Public property UseDefaultCredentials Gets or sets a value that indicates whether to set the Credentials property to the value of the CredentialCache.DefaultCredentials property. (Inherited from WebClientProtocol.)
Public property UserAgent Gets or sets the value for the user agent header that is sent with each request.
Top
Methods
  Name Description
Public method Abort Cancels a request to an XML Web service method. (Inherited from WebClientProtocol.)
Protected method CancelAsync Cancels an asynchronous call to an XML Web service method, unless the call has already completed.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method Static member GenerateXmlMappings(Type, ArrayList) Gets the XmlMembersMapping for each XML Web service method exposed by the specified type, and stores the mappings in the specified ArrayList.
Public method Static member GenerateXmlMappings(Type[], ArrayList) Gets the XmlMembersMapping for each XML Web service method exposed by the specified types, and stores the mappings in the specified ArrayList, as well as in a Hashtable that this method returns.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetWebRequest Creates a WebRequest for the specified URI. (Overrides WebClientProtocol.GetWebRequest(Uri).)
Protected method GetWebResponse(WebRequest) Returns a response from a synchronous request to an XML Web service method. (Overrides WebClientProtocol.GetWebResponse(WebRequest).)
Protected method GetWebResponse(WebRequest, IAsyncResult) Returns a response from an asynchronous request to an XML Web service method. (Overrides WebClientProtocol.GetWebResponse(WebRequest, IAsyncResult).)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Top
Events
  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top
Remarks

The properties on this class are used to control the behavior of the HTTP request object used to transmit the XML Web service request and response. The properties map to properties found on HttpWebRequest.

To communicate with an XML Web service using HTTP, you must create a proxy class deriving indirectly or directly from HttpWebClientProtocol for the XML Web service. Instead of creating the proxy class manually, you can use the Wsdl.exe tool to create a proxy class for a given XML Web service's service description.

Since HttpWebClientProtocol is the base class for all proxy classes, its properties are on your proxy classes. These properties are useful for controlling the request behavior of the underlying transport. For example, use the Proxy property for calling XML Web services through a firewall. Many of these properties are used to initialize the HttpWebRequest that makes the Web request.

SoapHttpClientProtocol , HttpGetClientProtocol, and HttpPostClientProtocol derive directly or indirectly from HttpWebClientProtocol to provide support for SOAP, HTTP-GET and HTTP-POST respectively.

Examples

The following example is an ASP.NET Web Form, which calls an XML Web service named Math. Within the EnterBtn_Click function, the Web Form allows the server to automatically redirect the client to other sites. It also sets client authentication credentials, proxy settings, the request encoding and the time out for the request before calling the XML Web service method.

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Net" %>

<html>
    <script language="VB" runat="server">

    Sub EnterBtn_Click(Src As Object, E As EventArgs)
        Dim math As New MyMath.Math()

        ' Allow the server to redirect the request.
        math.AllowAutoRedirect = True

        ' Set the client-side credentials using the Credentials property.
        Dim credentials = New NetworkCredential("Joe", "password", "mydomain")
        math.Credentials = credentials

        ' Set the proxy server to proxyserver, set the port to 80 and specify to bypass
        ' the proxy server for local addresses.
        Dim proxyObject = New WebProxy("http://proxyserver:80", True)
        math.Proxy = proxyObject

        ' Set the encoding to utf-8.
        math.RequestEncoding = System.Text.Encoding.UTF8

        ' Set the time out to 15 seconds.
        math.Timeout = 15000

        Dim iTotal As Integer = math.Add(Convert.ToInt32(Num1.Text), _
           Convert.ToInt32(Num2.Text))
        Total.Text = "Total: " & iTotal.ToString()
    End Sub

    </script>

    <body>
       <form action="MathClient.aspx" runat=server>

          Enter the two numbers you want to add and then press the Total button.
          <p>
          Number 1: <asp:textbox id="Num1" runat=server/>  +
          Number 2: <asp:textbox id="Num2" runat=server/> =
          <asp:button text="Total" Onclick="EnterBtn_Click" runat=server/>
          <p>
          <asp:label id="Total"  runat=server/>

       </form>
    </body>
 </html>
C#

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Net" %>

<html>
    <script language="C#" runat="server">
       void EnterBtn_Click(Object Src, EventArgs E) 
          {
             MyMath.Math math = new MyMath.Math();

             // Allow the server to redirect the request.
             math.AllowAutoRedirect = true;

             // Set the client-side credentials using the Credentials property.
             ICredentials credentials =
                new NetworkCredential("Joe","password","mydomain");
             math.Credentials = credentials;

             // Set the proxy server to proxyserver, set the port to 80, and specify to bypass
             // the proxy server for local addresses.
             IWebProxy proxyObject = new WebProxy("http://proxyserver:80",true);
             math.Proxy = proxyObject;

             // Set the encoding to utf-8.
             math.RequestEncoding = System.Text.Encoding.UTF8;

             // Set the time out to 15 seconds
             math.Timeout = 15000;

             int total = math.Add(Convert.ToInt32(Num1.Text),
                Convert.ToInt32(Num2.Text));
             Total.Text = "Total: " + total.ToString();
         }

    </script>

    <body>
       <form action="MathClient.aspx" runat=server>

          Enter the two numbers you want to add and then press the Total button.
          <p>
          Number 1: <asp:textbox id="Num1" runat=server/>  +
          Number 2: <asp:textbox id="Num2" runat=server/> =
          <asp:button text="Total" Onclick="EnterBtn_Click" runat=server/>
          <p>
          <asp:label id="Total"  runat=server/>

       </form>
    </body>
 </html>
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

The properties on this class are copied into a new instance of a WebRequest object for each XML Web service method call. While you can call XML Web service methods on the same WebClientProtocol instance from different threads at the same time, there is no synchronization done to ensure that a consistent snapshot of the properties gets transferred to the WebRequest object. Therefore, if you need to modify the properties and make concurrent method calls from different threads you should use a different instance of the XML Web service proxy or provide your own synchronization.

See Also

Reference

System.Web.Services.Protocols Namespace
WebClientProtocol
WebRequest
SoapHttpClientProtocol
HttpGetClientProtocol
HttpPostClientProtocol