WebClientProtocol

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

WebClientProtocol イベント

パブリック イベント

	名前	説明
	Disposed	コンポーネントの Disposed イベントを待機するイベント ハンドラを追加します。 ( Component から継承されます。)

参照

関連項目

WebClientProtocol クラス
System.Web.Services.Protocols 名前空間
SoapHttpClientProtocol クラス
HttpWebRequest

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

C#

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

C++

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

J#

/** @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>

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

             // 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 サービス プロキシの別のインスタンスを使用するか、独自に同期を行う必要があります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
WebClientProtocol メンバ
System.Web.Services.Protocols 名前空間
SoapHttpClientProtocol クラス
HttpWebRequest

WebClientProtocol コンストラクタ

WebClientProtocol クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Protected Sub New

Visual Basic (使用法)

Dim instance As New WebClientProtocol

C#

protected WebClientProtocol ()

C++

protected:
WebClientProtocol ()

J#

protected WebClientProtocol ()

JScript

protected function WebClientProtocol ()

使用例

Visual Basic

Class TempConvertService
    Inherits System.Web.Services.Protocols.WebClientProtocol
  
    Public Sub New()
       MyBase.New()
       ' Rest of class initialization.
    End Sub 
End Class 

C#

[System.Web.Services.WebServiceBindingAttribute(Name="Service1Soap",
     Namespace="http://tempuri.org/")]
class TempConvertService: System.Web.Services.Protocols.WebClientProtocol
 
{
    public TempConvertService(): base() 
    {
        // Rest of class initialization.
    }    

C++

[System::Web::Services::WebServiceBindingAttribute(Name="Service1Soap"
,
   Namespace="http://tempuri.org/")]
ref class TempConvertService: public System::Web::Services::Protocols::WebClientProtocol
{
public:
   TempConvertService() : WebClientProtocol()
   {
      // Rest of class initialization.
   }

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
WebClientProtocol クラス
WebClientProtocol メンバ
System.Web.Services.Protocols 名前空間

WebClientProtocol プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Container	Component を格納している IContainer を取得します。 ( Component から継承されます。)
	Site	Component の ISite を取得または設定します。 ( Component から継承されます。)
	UseDefaultCredentials	Credentials プロパティを CredentialCache.DefaultCredentials プロパティの値に設定するかどうかを示す値を取得または設定します。

プロテクト プロパティ

	名前	説明
	CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。 ( Component から継承されます。)
	DesignMode	Component が現在デザイン モードかどうかを示す値を取得します。 ( Component から継承されます。)
	Events	Component に結び付けられているイベント ハンドラのリストを取得します。 ( Component から継承されます。)

参照

関連項目

WebClientProtocol クラス
System.Web.Services.Protocols 名前空間
SoapHttpClientProtocol クラス
HttpWebRequest

WebClientProtocol メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Abort	XML Web サービス メソッドへの要求をキャンセルします。
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 ( Component から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	Component の名前を格納している String を返します (存在する場合)。このメソッドはオーバーライドできません。 ( Component から継承されます。)

プロテクト メソッド

	名前	説明
	AddToCache	クライアント プロトコル ハンドラのインスタンスをキャッシュに追加します。
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 ( Component から継承されます。)
	Finalize	Component がガベージ コレクションによってクリアされる前に、アンマネージ リソースを解放し、その他のクリーンアップ操作を実行します。 ( Component から継承されます。)
	GetFromCache	クライアント プロトコル ハンドラのインスタンスをキャッシュから取得します。
	GetService	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 ( Component から継承されます。)
	GetWebRequest	指定した uri に対する WebRequest インスタンスを作成します。この保護されているメソッドは、XML Web サービス クライアント インフラストラクチャから呼び出され、新しいWebRequest トランスポート オブジェクトを取得して、XML Web サービス要求を送信します。
	GetWebResponse	オーバーロードされます。 XML Web サービス メソッドへの要求から応答を返します。この保護されているメソッドは、XML Web サービス クライアント インフラストラクチャから呼び出され、同期の XML Web サービス要求からの応答を取得します。
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)

参照

関連項目

WebClientProtocol クラス
System.Web.Services.Protocols 名前空間
SoapHttpClientProtocol クラス
HttpWebRequest

WebClientProtocol メンバ

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

WebClientProtocol データ型で公開されるメンバを以下の表に示します。

プロテクト コンストラクタ

	名前	説明
	WebClientProtocol	WebClientProtocol クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Container	Component を格納している IContainer を取得します。(Component から継承されます。)
	Site	Component の ISite を取得または設定します。(Component から継承されます。)
	UseDefaultCredentials	Credentials プロパティを CredentialCache.DefaultCredentials プロパティの値に設定するかどうかを示す値を取得または設定します。

プロテクト プロパティ

	名前	説明
	CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。(Component から継承されます。)
	DesignMode	Component が現在デザイン モードかどうかを示す値を取得します。(Component から継承されます。)
	Events	Component に結び付けられているイベント ハンドラのリストを取得します。(Component から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Abort	XML Web サービス メソッドへの要求をキャンセルします。
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 (Component から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	Component の名前を格納している String を返します (存在する場合)。このメソッドはオーバーライドできません。 (Component から継承されます。)

プロテクト メソッド

	名前	説明
	AddToCache	クライアント プロトコル ハンドラのインスタンスをキャッシュに追加します。
	Dispose	オーバーロードされます。 Component によって使用されているリソースを解放します。 (Component から継承されます。)
	Finalize	Component がガベージ コレクションによってクリアされる前に、アンマネージ リソースを解放し、その他のクリーンアップ操作を実行します。 (Component から継承されます。)
	GetFromCache	クライアント プロトコル ハンドラのインスタンスをキャッシュから取得します。
	GetService	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 (Component から継承されます。)
	GetWebRequest	指定した uri に対する WebRequest インスタンスを作成します。この保護されているメソッドは、XML Web サービス クライアント インフラストラクチャから呼び出され、新しいWebRequest トランスポート オブジェクトを取得して、XML Web サービス要求を送信します。
	GetWebResponse	オーバーロードされます。 XML Web サービス メソッドへの要求から応答を返します。この保護されているメソッドは、XML Web サービス クライアント インフラストラクチャから呼び出され、同期の XML Web サービス要求からの応答を取得します。
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)

パブリック イベント

	名前	説明
	Disposed	コンポーネントの Disposed イベントを待機するイベント ハンドラを追加します。(Component から継承されます。)

参照

関連項目

WebClientProtocol クラス
System.Web.Services.Protocols 名前空間
SoapHttpClientProtocol クラス
HttpWebRequest