HttpWebClientProtocol HttpWebClientProtocol HttpWebClientProtocol HttpWebClientProtocol Class

定義

HTTP トランスポート プロトコルを使用するすべての XML Web サービス クライアント プロキシの基本クラスを表します。Represents the base class for all XML Web service client proxies that use the HTTP transport protocol.

public ref class HttpWebClientProtocol abstract : System::Web::Services::Protocols::WebClientProtocol
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class HttpWebClientProtocol : System.Web.Services.Protocols.WebClientProtocol
type HttpWebClientProtocol = class
    inherit WebClientProtocol
Public MustInherit Class HttpWebClientProtocol
Inherits WebClientProtocol
継承
派生
属性

次の例は、という名前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 フォームを使用して、サーバーがクライアントを他のサイトに自動的にリダイレクトすることができます。Within the EnterBtn_Click function, the Web Form allows the server to automatically redirect the client to other sites. また、XML Web サービスメソッドを呼び出す前に、クライアント認証の資格情報、プロキシ設定、要求のエンコーディング、および要求のタイムアウトを設定します。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.

<%@ 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>
   
<%@ 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>
   

注釈

このクラスのプロパティは、XML Web サービスの要求と応答を送信するために使用される HTTP 要求オブジェクトの動作を制御するために使用されます。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. プロパティは、でHttpWebRequest見つかったプロパティにマップされます。The properties map to properties found on HttpWebRequest.

HTTP を使用して xml web サービスと通信するには、xml web サービスに対して間接HttpWebClientProtocol的に、またはから直接派生するプロキシクラスを作成する必要があります。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. プロキシクラスを手動で作成する代わりに、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.

HttpWebClientProtocol はすべてのプロキシクラスの基本クラスであるため、そのプロパティはプロキシクラスにあります。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. たとえば、ファイアウォール経由Proxyで XML Web サービスを呼び出すには、プロパティを使用します。For example, use the Proxy property for calling XML Web services through a firewall. これらのプロパティの多くは、 HttpWebRequest Web 要求を行うを初期化するために使用されます。Many of these properties are used to initialize the HttpWebRequest that makes the Web request.

SoapHttpClientProtocolHttpGetClientProtocol、およびHttpPostClientProtocolは、それぞれ SOAP、 HttpWebClientProtocol http GET、および http POST のサポートを提供するために、から直接または間接的に派生します。SoapHttpClientProtocol, HttpGetClientProtocol, and HttpPostClientProtocol derive directly or indirectly from HttpWebClientProtocol to provide support for SOAP, HTTP-GET and HTTP-POST respectively.

コンストラクター

HttpWebClientProtocol() HttpWebClientProtocol() HttpWebClientProtocol() HttpWebClientProtocol()

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

プロパティ

AllowAutoRedirect AllowAutoRedirect AllowAutoRedirect AllowAutoRedirect

クライアントがサーバーのリダイレクトに自動的に従うかどうかを取得または設定します。Gets or sets whether the client automatically follows server redirects.

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

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

(Inherited from Component)
ClientCertificates ClientCertificates ClientCertificates ClientCertificates

クライアント証明書のコレクションを取得します。Gets the collection of client certificates.

ConnectionGroupName ConnectionGroupName ConnectionGroupName ConnectionGroupName

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

(Inherited from WebClientProtocol)
Container Container Container Container

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

(Inherited from Component)
CookieContainer CookieContainer CookieContainer CookieContainer

クッキーのコレクションを取得または設定します。Gets or sets the collection of cookies.

Credentials Credentials Credentials Credentials

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

(Inherited from WebClientProtocol)
DesignMode DesignMode DesignMode DesignMode

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

(Inherited from Component)
EnableDecompression EnableDecompression EnableDecompression EnableDecompression

この HttpWebClientProtocol の圧縮解除が有効かどうかを示す値を取得または設定します。Gets or sets a value that indicates whether decompression is enabled for this HttpWebClientProtocol.

Events Events Events Events

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

(Inherited from Component)
PreAuthenticate PreAuthenticate PreAuthenticate PreAuthenticate

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

(Inherited from WebClientProtocol)
Proxy Proxy Proxy Proxy

ファイアウォールをとおして XML Web サービス要求を行うためのプロキシ情報を取得または設定します。Gets or sets proxy information for making an XML Web service request through a firewall.

RequestEncoding RequestEncoding RequestEncoding RequestEncoding

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

(Inherited from WebClientProtocol)
Site Site Site Site

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

(Inherited from Component)
Timeout Timeout Timeout Timeout

同期的な 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).

(Inherited from WebClientProtocol)
UnsafeAuthenticatedConnectionSharing UnsafeAuthenticatedConnectionSharing UnsafeAuthenticatedConnectionSharing UnsafeAuthenticatedConnectionSharing

XML Web サービスをホストしている Web サービスに接続するときにクライアントが NTLM 認証を使用する場合、接続共有が有効になっているかどうかを示す値を取得または設定します。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.

Url Url Url Url

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

(Inherited from WebClientProtocol)
UseDefaultCredentials UseDefaultCredentials UseDefaultCredentials UseDefaultCredentials

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

(Inherited from WebClientProtocol)
UserAgent UserAgent UserAgent UserAgent

それぞれの要求と共に送信されるユーザー エージェント ヘッダーの値を取得または設定します。Gets or sets the value for the user agent header that is sent with each request.

メソッド

Abort() Abort() Abort() Abort()

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

(Inherited from WebClientProtocol)
CancelAsync(Object) CancelAsync(Object) CancelAsync(Object) CancelAsync(Object)

呼び出しが完了済みの場合を除き、XML Web サービス メソッドの非同期呼び出しをキャンセルします。Cancels an asynchronous call to an XML Web service method, unless the call has already completed.

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

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

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()

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

(Inherited from Component)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

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

(Inherited from Component)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GenerateXmlMappings(Type, ArrayList) GenerateXmlMappings(Type, ArrayList) GenerateXmlMappings(Type, ArrayList) GenerateXmlMappings(Type, ArrayList)

指定された型で公開される各 XML Web サービス メソッドの XmlMembersMapping を取得し、マップを指定された ArrayList に格納します。Gets the XmlMembersMapping for each XML Web service method exposed by the specified type, and stores the mappings in the specified ArrayList.

GenerateXmlMappings(Type[], ArrayList) GenerateXmlMappings(Type[], ArrayList) GenerateXmlMappings(Type[], ArrayList) GenerateXmlMappings(Type[], ArrayList)

指定された型で公開される各 XML Web サービス メソッドの XmlMembersMapping を取得し、マップを指定された ArrayList、およびこのメソッドから返される Hashtable に格納します。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.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

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

(Inherited from MarshalByRefObject)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

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

(Inherited from Component)
GetType() GetType() GetType() GetType()

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

(Inherited from Object)
GetWebRequest(Uri) GetWebRequest(Uri) GetWebRequest(Uri) GetWebRequest(Uri)

指定した URI に対する WebRequest を作成します。Creates a WebRequest for the specified URI.

GetWebResponse(WebRequest) GetWebResponse(WebRequest) GetWebResponse(WebRequest) GetWebResponse(WebRequest)

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

GetWebResponse(WebRequest, IAsyncResult) GetWebResponse(WebRequest, IAsyncResult) GetWebResponse(WebRequest, IAsyncResult) GetWebResponse(WebRequest, IAsyncResult)

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

InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

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

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

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

(Inherited from MarshalByRefObject)
ToString() ToString() ToString() ToString()

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

(Inherited from Component)

イベント

Disposed Disposed Disposed Disposed

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

(Inherited from 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 gets 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.

こちらもご覧ください