WebClientProtocol クラス


ASP.NET で作成されたすべての XML Web サービス クライアント プロキシの基本クラスを指定します。Specifies the base class for all XML Web service client proxies created using ASP.NET.

public ref class WebClientProtocol abstract : System::ComponentModel::Component
public abstract class WebClientProtocol : System.ComponentModel.Component
type WebClientProtocol = class
    inherit Component
Public MustInherit Class WebClientProtocol
Inherits Component

次の例は、という名前Mathの XML web サービスを呼び出す ASP.NET web フォームです。The following example is an ASP.NET Web Form, which calls an XML Web service named Math. EnterBtn_Click関数内では、web フォームは、リモート XML web サービスメソッドを呼び出す前に、プロキシクラスのプロキシ情報とクライアント資格情報を設定します。Within the EnterBtn_Click function, the Web Form sets proxy information and client credentials on the proxy class prior to calling the remote XML Web service method.


この例には、ユーザー入力を受け付けるテキスト ボックスがあります。これにより、セキュリティが脆弱になる可能性があります。This example has a text box that accepts user input, which is a potential security threat. 既定では、ASP.NET Web ページによって、ユーザー入力にスクリプトまたは HTML 要素が含まれていないかどうかが検証されます。By default, ASP.NET Web pages validate that user input does not include script or HTML elements. 詳細については、「スクリプトによる攻略の概要」を参照してください。For more information, see Script Exploits Overview.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Net" %>
    <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();
       <form action="MathClient.aspx" runat=server>
          Enter the two numbers you want to add and then press the Total button.
          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/>
          <asp:label id="Total"  runat=server/>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Net" %>
    <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
       <form action="MathClient.aspx" runat=server>
          Enter the two numbers you want to add and then press the Total button.
          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/>
          <asp:label id="Total"  runat=server/>


WebClientProtocolクラスのプロパティは、XML Web サービスの要求と応答を送信するために使用されるトランスポートの動作を制御するために使用されます。The properties of the WebClientProtocol class are used to control the behavior of the transport used to transmit the XML Web service request and response. このクラスのプロパティは、でWebRequest見つかったプロパティにマップされます。The properties on this class map to properties found on WebRequest. など、からWebRequest HttpWebRequest派生したクラスのインスタンスは、ASP.NET を使用して作成された XML Web サービスのトランスポート機構として使用されます。Instances of classes deriving from WebRequest, such as HttpWebRequest, are used as the transport mechanism for XML Web services created using ASP.NET.

Xml web サービスと通信するには、呼び出し元の xml web サービスに対して間接WebClientProtocol的に、またはから直接派生するプロキシクラスを作成する必要があります。To communicate with an XML Web service, you must create a proxy class deriving indirectly or directly from WebClientProtocol for the XML Web service you want to call. プロキシクラスを手動で作成する代わりに、Wsdl.exe ツールを使用して、特定の XML Web サービスのサービスの説明に対してプロキシクラスを作成できます。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. WebClientProtocolクライアントプロキシの基底クラスであるため、プロキシクラスにはプロパティがあります。Since WebClientProtocol is the base class for your client proxy, you will find its properties on your proxy classes. これらのプロパティは、基になるトランスポートの要求動作を制御するのに役立ちます。These properties are useful for controlling the request behavior of the underlying transport. たとえば、認証されCredentialsた XML Web サービスを呼び出すには、プロパティを使用します。For instance, use the Credentials property for calling authenticated XML Web services. 多くのWebRequestプロパティは、Web 要求の作成に使用されるオブジェクトを初期化するために使用されます。 WebClientProtocolMany of the WebClientProtocol properties are used to initialize the WebRequest object that is used to make the Web request.



WebClientProtocol クラスの新しいインスタンスを初期化します。Initializes a new instance of the WebClientProtocol class.



コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。Gets a value indicating whether the component can raise an event.

(継承元 Component)

要求に対して使用する接続グループの名前を取得または設定します。Gets or sets the name of the connection group for the request.


IContainer を格納している Component を取得します。Gets the IContainer that contains the Component.

(継承元 Component)

XML Web サービス クライアント認証のセキュリティ資格情報を取得または設定します。Gets or sets security credentials for XML Web service client authentication.


Component が現在デザイン モードかどうかを示す値を取得します。Gets a value that indicates whether the Component is currently in design mode.

(継承元 Component)

Component に結び付けられているイベント ハンドラーのリストを取得します。Gets the list of event handlers that are attached to this Component.

(継承元 Component)

事前認証を有効にするかどうかを取得または設定します。Gets or sets whether pre-authentication is enabled.


クライアントが XML Web サービスを要求するときに使用される EncodingThe Encoding used to make the client request to the XML Web service.


ComponentISite を取得または設定します。Gets or sets the ISite of the Component.

(継承元 Component)

同期的な XML Web サービスの要求に対する返答の受信を XML Web サービス クライアントが待機する時間 (ミリ秒単位) を示します。Indicates the time an XML Web service client waits for the reply to a synchronous XML Web service request to arrive (in milliseconds).


クライアントが要求している XML Web サービスのベース URL を取得または設定します。Gets or sets the base URL of the XML Web service the client is requesting.


Credentials プロパティを DefaultCredentials プロパティの値に設定するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether to set the Credentials property to the value of the DefaultCredentials property.



XML Web サービス メソッドへの要求をキャンセルします。Cancels a request to an XML Web service method.

AddToCache(Type, Object)

クライアント プロトコル ハンドラーのインスタンスをキャッシュに追加します。Add an instance of the client protocol handler to the cache.


リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(継承元 MarshalByRefObject)

Component によって使用されているすべてのリソースを解放します。Releases all resources used by the Component.

(継承元 Component)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(継承元 Component)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)

クライアント プロトコル ハンドラーのインスタンスをキャッシュから取得します。Gets an instance of a client protocol handler from the cache.


既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(継承元 MarshalByRefObject)

Component またはその Container で提供されるサービスを表すオブジェクトを返します。Returns an object that represents a service provided by the Component or by its Container.

(継承元 Component)

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)

指定した uri に対する WebRequest インスタンスを作成します。Creates a WebRequest instance for the specified uri. この保護されているメソッドは、XML Web サービス クライアント インフラストラクチャから呼び出され、新しいWebRequest トランスポート オブジェクトを取得して、XML Web サービス要求を送信します。This protected method is called by the XML Web service client infrastructure to get a new WebRequest transport object to transmit the XML Web service request.


XML Web サービス メソッドへの同期要求から応答を返します。Returns a response from a synchronous request to an XML Web service method.

GetWebResponse(WebRequest, IAsyncResult)

XML Web サービス メソッドへの非同期要求から応答を返します。Returns a response from an asynchronous request to an XML Web service method. この保護されているメソッドは、XML Web サービス クライアント インフラストラクチャから呼び出され、非同期の XML Web サービス要求からの応答を取得します。This protected method is called by the XML Web service client infrastructure to get the response from an asynchronous XML Web service request.


このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。Obtains a lifetime service object to control the lifetime policy for this instance.

(継承元 MarshalByRefObject)

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。Creates a shallow copy of the current MarshalByRefObject object.

(継承元 MarshalByRefObject)

Component の名前 (存在する場合) を格納する String を返します。Returns a String containing the name of the Component, if any. このメソッドはオーバーライドできません。This method should not be overridden.

(継承元 Component)



Dispose() メソッドの呼び出しによってコンポーネントが破棄されると発生します。Occurs when the component is disposed by a call to the Dispose() method.

(継承元 Component)


スレッド セーフ

このクラスのプロパティは、XML Web サービスのメソッド呼び出しごとWebRequestに、オブジェクトの新しいインスタンスにコピーされます。The properties on this class are copied into a new instance of a WebRequest object for each XML Web service method call. 同時に異なるスレッドから同じWebClientProtocolインスタンス上で XML Web サービスメソッドを呼び出すことができますが、プロパティの一貫性のあるスナップショットが確実にWebRequestオブジェクトに転送されるように同期は実行されません。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 will get transferred to the WebRequest object. したがって、プロパティを変更し、異なるスレッドからの同時メソッド呼び出しを行う必要がある場合は、XML Web サービスプロキシの別のインスタンスを使用するか、独自の同期を提供する必要があります。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.