WebClientProtocol クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebClientProtocol クラス

ASP.NET で作成されたすべての XML Web サービスクライアントプロキシの基本クラスを指定します。

名前空間: System.Web.Services.Protocols
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public MustInherit Class
 WebClientProtocol
    Inherits Component

Visual Basic (使用法)

Dim instance As WebClientProtocol

[ComVisibleAttribute(true)] 
public abstract class WebClientProtocol : Component

C++

[ComVisibleAttribute(true)] 
public ref class WebClientProtocol abstract
 : public Component

/** @attribute ComVisibleAttribute(true) */ 
public abstract class WebClientProtocol extends
 Component

JScript

ComVisibleAttribute(true) 
public abstract class WebClientProtocol extends
 Component

解説

WebClientProtocol クラスのプロパティを使用して、XML Web サービスの要求と応答を送信するために使用するトランスポートの動作を制御します。このクラスのプロパティは、WebRequest のプロパティに割り当てられます。HttpWebRequest などの WebRequest から派生したクラスのインスタンスは、ASP.NET で作成された XML Web サービスのトランスポート機構として使用されます。

XML Web サービスと通信する場合は、呼び出す XML Web サービスで使用する WebClientProtocol から間接または直接に派生するプロキシクラスを作成する必要があります。プロキシクラスを手動で作成する代わりに、Wsdl.exe ツールを使用して、指定された XML Web サービスのサービスの説明からプロキシクラスを作成できます。WebClientProtocol は、クライアントプロキシの基本クラスであるため、そのプロパティと作成したプロキシクラスのプロパティは同じものになります。これらのプロパティは、基になるトランスポートの要求動作を制御するのに役立ちます。たとえば、認証済みの XML Web サービスを呼び出すためには Credentials プロパティを使用します。WebClientProtocol の多数のプロパティは、Web 要求を行うために使用される WebRequest オブジェクトの初期化に使用されます。

使用例

XML Web サービス (Math) を呼び出す ASP.NET Web フォームの例を次に示します。この Web フォームでは、EnterBtn_Click 関数の中で、プロキシ情報とクライアント資格情報をプロキシクラスに設定してから、リモート XML Web サービスメソッドを呼び出します。

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()
            
            ' Set the client-side credentials using the Credentials
 property.
            Dim credentials As New
 NetworkCredential("Joe", "password",
 "mydomain")
            math.Credentials = credentials
            
            ' Do not allow the server to redirect the request.
            math.AllowAutoRedirect = False
            
            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>

<%@ 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();

             // Set the client-side credentials using the Credentials
 property.
             ICredentials credentials = new NetworkCredential("Joe"
,"mydomain","password");
             math.Credentials = credentials;
             
             // Do not allow the server to redirect the request.
             math.AllowAutoRedirect = false;
             
             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>

JScript

<%@ Page Language="JSCRIPT" src="source.js" %>
<%@ Import Namespace="System.Net" %>
<html>
    <script language="JSCRIPT" runat="server">
    
        function EnterBtn_Click(src : Object, e : EventArgs){
            var math : MyMath.Math = new MyMath.Math()
            
            // Set the client-side credentials using the Credentials
 property.
            var credentials : NetworkCredential = new
 NetworkCredential("Joe", "password", "mydomain")
            math.Credentials = credentials
            
            // Do not allow the server to redirect the request.
            math.AllowAutoRedirect = false
            
            var iTotal : int = math.Add(Convert.ToInt32(Num1.Text),
 Convert.ToInt32(Num2.Text))
            Total.Text = "Total: " + iTotal.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>

継承階層

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
      System.Web.Services.Protocols.WebClientProtocol
         System.Web.Services.Protocols.HttpWebClientProtocol

スレッドセーフ

このクラスのプロパティは、XML Web サービスメソッドを呼び出すたびに、WebRequest オブジェクトの新しいインスタンスにコピーされます。複数の異なるスレッドから同じ WebClientProtocol インスタンスで XML Web サービスメソッドを同時に呼び出すことはできますが、プロパティの一貫したスナップショットが WebRequest オブジェクトに転送されるようにするための同期は行われません。したがって、複数の異なるスレッドからプロパティを変更したり、メソッドの呼び出しを同時に行う必要がある場合は、XML Web サービスプロキシの別のインスタンスを使用するか、独自に同期を行う必要があります。