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

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

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

ServiceDescriptionImporter クラス

XML Web サービスのためのクライアントプロキシクラスの生成方法を公開します。

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

Visual Basic (宣言)

Public Class ServiceDescriptionImporter

Visual Basic (使用法)

Dim instance As ServiceDescriptionImporter

public class ServiceDescriptionImporter

C++

public ref class ServiceDescriptionImporter

public class ServiceDescriptionImporter

JScript

public class ServiceDescriptionImporter

解説

XML Web サービスへのインターフェイスは、通常 Web サービス記述言語 (WSDL: Web Services Description Language) ファイルで記述されます。たとえば、http://localhost/service.asmx で公開されている ASP.NET を使用した Web サービスの WSDL の説明を取得するには、単に http://localhost/service.asmx?WSDL に移動します。

ServiceDescriptionImporter クラスを使用すると、WSDL の説明に含まれている情報を簡単に System.CodeDom.CodeCompileUnit オブジェクトにインポートできます。Style パラメータの値を調整することによって、ServiceDescriptionImporter インスタンスに対して、Web サービスの機能を透過的に呼び出すことによって提供するクライアントプロキシクラスを生成するか、Web サービスの機能を実装せずにカプセル化する抽象クラスを生成するかを指示できます。

結果の CodeCompileUnit オブジェクト内のコードは、直接呼び出すことも、指定した言語でエクスポートすることもできます。

使用例

ServiceDescriptionImporter クラスを使用して WSDL ファイルで記述されている XML Web サービスを呼び出すプロキシクライアントコードを生成する例を次に示します。

using System;
using System.Web.Services.Description;
using System.CodeDom;
using System.CodeDom.Compiler;
using System.Security.Permissions;

public class Import {

    public static void Main()
 
    {
        Run();
    }

    [PermissionSetAttribute(SecurityAction.Demand, Name = "Full Trust")]
    public static void Run()
    {
    // Get a WSDL file describing a service.
    ServiceDescription description = ServiceDescription.Read("service.wsdl");

    // Initialize a service description importer.
    ServiceDescriptionImporter importer = new ServiceDescriptionImporter();
    importer.ProtocolName = "Soap12";  // Use SOAP 1.2.
    importer.AddServiceDescription(description,null,null);

    // Report on the service descriptions.
    Console.WriteLine("Importing {0} service descriptions with {1} associated
 schemas.",
                      importer.ServiceDescriptions.Count, importer.Schemas.Count);

    // Generate a proxy client.
    importer.Style = ServiceDescriptionImportStyle.Client;

    // Generate properties to represent primitive values.
    importer.CodeGenerationOptions = System.Xml.Serialization.CodeGenerationOptions.GenerateProperties;

    // Initialize a Code-DOM tree into which we will import the service.
    CodeNamespace nmspace = new CodeNamespace();
    CodeCompileUnit unit = new CodeCompileUnit();
    unit.Namespaces.Add(nmspace);

    // Import the service into the Code-DOM tree. This creates proxy
 code
    // that uses the service.
    ServiceDescriptionImportWarnings warning = importer.Import(nmspace,unit);

    if (warning == 0)
    {
        // Generate and print the proxy code in C#.
        CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp");
        provider.GenerateCodeFromCompileUnit(unit, Console.Out, new
 CodeGeneratorOptions() );
    }
    else
    {
        // Print an error message.
        Console.WriteLine(warning); 
    }
}


}

C++

#using <System.Xml.dll>
#using <System.Web.Services.dll>
#using <System.dll>

using namespace System;
using namespace System::Web::Services::Description;
using namespace System::CodeDom;
using namespace System::CodeDom::Compiler;

int main()
{
   // Get a WSDL file describing a service.
   ServiceDescription^ description = ServiceDescription::Read( "service.wsdl"
 );

   // Initialize a service description importer.
   ServiceDescriptionImporter^ importer = gcnew ServiceDescriptionImporter;
   importer->ProtocolName = "Soap12"; // Use SOAP 1.2.
   importer->AddServiceDescription( description, nullptr, nullptr );

   // Report on the service descriptions.
   Console::WriteLine( "Importing {0} service descriptions with {1} associated
 schemas.", importer->ServiceDescriptions->Count, importer->Schemas->Count
 );

   // Generate a proxy client.
   importer->Style = ServiceDescriptionImportStyle::Client;

   // Generate properties to represent primitive values.
   importer->CodeGenerationOptions = System::Xml::Serialization::CodeGenerationOptions::GenerateProperties;

   // Initialize a Code-DOM tree into which we will import the service.
   CodeNamespace^ nmspace = gcnew CodeNamespace;
   CodeCompileUnit^ unit = gcnew CodeCompileUnit;
   unit->Namespaces->Add( nmspace );
   
   // Import the service into the Code-DOM tree. This creates proxy
 code
   // that uses the service.
   ServiceDescriptionImportWarnings warning = importer->Import(nmspace,unit);
   if ( warning == (ServiceDescriptionImportWarnings)0 )
   {
      // Generate and print the proxy code in C#.
      CodeDomProvider^ provider = CodeDomProvider::CreateProvider( "CSharp"
 );
      ICodeGenerator^ generator = provider->CreateGenerator();
      generator->GenerateCodeFromCompileUnit( unit, Console::Out, gcnew CodeGeneratorOptions
 );
   }
   else
   {
      // Print an error message.
      Console::WriteLine( warning );
   }
}