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

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

HttpMethodAttribute クラス

HTTP-GET または HTTP-POST を使用する XML Web サービスクライアントにこの属性を適用し、XML Web サービスに送信されたパラメータをシリアル化する型、および XML Web サービスメソッドから応答を読み取る型を設定します。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Method)> _
Public NotInheritable Class
 HttpMethodAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As HttpMethodAttribute

[AttributeUsageAttribute(AttributeTargets.Method)] 
public sealed class HttpMethodAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Method)] 
public ref class HttpMethodAttribute sealed
 : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Method) */ 
public final class HttpMethodAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Method) 
public final class HttpMethodAttribute extends
 Attribute

解説

XML Web サービスクライアントが HTTP-GET を使用して XML Web サービスメソッドを呼び出す場合は、ReturnFormatter を XmlReturnReader に設定し、ParameterFormatter を UrlParameterWriter に設定する必要があります。HTTP-POST を使用して XML Web サービスを呼び出す XML Web サービスクライアントでは、ReturnFormatter を XmlReturnReader に設定し、ParameterFormatter を HtmlFormParameterWriter に設定する必要があります。

使用例

HTTP-POST を使用して XML Web サービスユーティリティを呼び出すために、Wsdl.exe ユーティリティによって生成されるプロキシクラスの例を次に示します。Wsdl.exe は、ReturnFormatter および ParameterFormatter に対応する適切な型を自動的に指定し、またプロキシクラスが HttpPostClientProtocol から継承することも指定します。

Visual Basic

Public Class MyUser
    Inherits System.Web.Services.Protocols.HttpPostClientProtocol
    
    
    Public Sub New()
        Me.Url = "http://www.contoso.com/username.asmx"
    End Sub 'New
    
    <HttpMethodAttribute(GetType(XmlReturnReader), GetType(HtmlFormParameterWriter))>
 _
    Public Function GetUserName() As
 UserName
        Return CType(Me.Invoke("GetUserName",
 Me.Url + "/GetUserName", New
 Object(0) {}), UserName)
    End Function 'GetUserName
    
    
    Public Function BeginGetUserName(callback
 As System.AsyncCallback, asyncState As Object)
 As System.IAsyncResult
        Return Me.BeginInvoke("GetUserName",
 Me.Url + "/GetUserName", New
 Object(0) {}, callback, asyncState)
    End Function 'BeginGetUserName
    
    
    Public Function EndGetUserName(asyncResult
 As System.IAsyncResult) As UserName
        Return CType(Me.EndInvoke(asyncResult),
 UserName)
    End Function 'EndGetUserName
End Class 'MyUser

<XmlRootAttribute(Namespace := "http://tempuri.org/",
 IsNullable := True)> _
Public Class UserName
    Public Name As String
    Public Domain As String

End Class 'UserName

public class MyUser : System.Web.Services.Protocols.HttpPostClientProtocol
 {
    
    public MyUser() {
        this.Url = "http://www.contoso.com/username.asmx";
    }
    
    [System.Web.Services.Protocols.HttpMethodAttribute(typeof(System.Web.Services.Protocols.XmlReturnReader),
 typeof(System.Web.Services.Protocols.HtmlFormParameterWriter))]
    public UserName GetUserName() {
        return ((UserName)(this.Invoke("GetUserName",
 (this.Url + "/GetUserName"), new
 object[0])));
    }
    
    public System.IAsyncResult BeginGetUserName(System.AsyncCallback
 callback, object asyncState) {
        return this.BeginInvoke("GetUserName",
 (this.Url + "/GetUserName"), new
 object[0], callback, asyncState);
    }
    
    public UserName EndGetUserName(System.IAsyncResult asyncResult)
 {
        return ((UserName)(this.EndInvoke(asyncResult)));
    }
}

[System.Xml.Serialization.XmlRootAttribute(Namespace="http://tempuri.org/",
 IsNullable=true)]
public class UserName {
    
    public string Name;
    
    public string Domain;
}

C++

[System::Xml::Serialization::XmlRootAttribute(Namespace="http://tempuri.org/"
,IsNullable=true)]
public ref class UserName
{
public:
   String^ Name;
   String^ Domain;
};

public ref class MyUser: public
 System::Web::Services::Protocols::HttpPostClientProtocol
{
public:
   MyUser()
   {
      this->Url = "http://www.contoso.com/username.asmx";
   }

   [System::Web::Services::Protocols::HttpMethodAttribute(System::Web::Services::Protocols::XmlReturnReader::typeid
,System::Web::Services::Protocols::HtmlFormParameterWriter::typeid)]
   UserName^ GetUserName()
   {
      return (dynamic_cast<UserName^>(this->Invoke(
 "GetUserName", (String::Concat( this->Url, "/GetUserName"
 )), gcnew array<Object^>(0) )));
   }

   System::IAsyncResult^ BeginGetUserName( System::AsyncCallback^ callback, Object^
 asyncState )
   {
      return this->BeginInvoke( "GetUserName",
 (String::Concat( this->Url, "/GetUserName" )),
 gcnew array<Object^>(0), callback, asyncState );
   }

   UserName^ EndGetUserName( System::IAsyncResult^ asyncResult )
   {
      return (dynamic_cast<UserName^>(this->EndInvoke(
 asyncResult )));
   }
};

public class MyUser extends System.Web.Services.Protocols.HttpPostClientProtocol
{
    public MyUser()
    {
        this.set_Url("http://www.contoso.com/username.asmx");
    } //MyUser

    /** @attribute System.Web.Services.Protocols.HttpMethodAttribute
        (System.Web.Services.Protocols.XmlReturnReader .class
,
        System.Web.Services.Protocols.HtmlFormParameterWriter .class)
     */
    public UserName GetUserName()
    {
        return ((UserName)(this.Invoke("GetUserName",
 this.get_Url()
            + "/GetUserName", new Object[0])));
    } //GetUserName

    public System.IAsyncResult BeginGetUserName(System.AsyncCallback
 callback,
        Object asyncState)
    {
        return this.BeginInvoke("GetUserName",
 this.get_Url()
            + "/GetUserName", new Object[0], callback,
 asyncState);
    } //BeginGetUserName

    public UserName EndGetUserName(System.IAsyncResult asyncResult)
    {
        return ((UserName)(this.EndInvoke(asyncResult)));
    } //EndGetUserName
} //MyUser

/** @attribute System.Xml.Serialization.XmlRootAttribute
    (Namespace = "http://tempuri.org/", IsNullable = true)
 */
public class UserName
{
    public String name;
    public String domain;
} //UserName

JScript

class MyUser extends System.Web.Services.Protocols.HttpPostClientProtocol{

    function MyUser(){
        this.Url = "http://www.contoso.com/username.asmx"
    } //New

    public HttpMethodAttribute(XmlReturnReader, HtmlFormParameterWriter)
    function GetUserName() : UserName{
        return UserName(this.Invoke("GetUserName",
 this.Url + "/GetUserName", new
 Object[0]))
    } //GetUserName

    function BeginGetUserName(callback : System.AsyncCallback,
 asyncState : Object) : System.IAsyncResult{
        return this.BeginInvoke("GetUserName",
 this.Url + "/GetUserName", new
 Object[0], callback, asyncState)
    } //BeginGetUserName

    function EndGetUserName(asyncResult : System.IAsyncResult)
 : UserName{
        return UserName(this.EndInvoke(asyncResult))
    } //EndGetUserName
} //MyUser

public XmlRootAttribute(Namespace = "http://tempuri.org/",
 IsNullable = true)
class UserName{
    var Name : String
    var Domain : String

} //UserName