ServiceDescriptionImporter

.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

C#

public class ServiceDescriptionImporter

C++

public ref class ServiceDescriptionImporter

J#

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 サービスを呼び出すプロキシ クライアント コードを生成する例を次に示します。

C#

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

継承階層

System.Object
  System.Web.Services.Description.ServiceDescriptionImporter

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
ServiceDescriptionImporter メンバ
System.Web.Services.Description 名前空間

ServiceDescriptionImporter コンストラクタ

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

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New ServiceDescriptionImporter

C#

public ServiceDescriptionImporter ()

C++

public:
ServiceDescriptionImporter ()

J#

public ServiceDescriptionImporter ()

JScript

public function ServiceDescriptionImporter
 ()

使用例

このコンストラクタの使用例を次に示します。

C#

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

C++

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

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

ServiceDescriptionImporter プロパティ

パブリック プロパティ

	名前	説明
	CodeGenerationOptions	コード生成のさまざまなオプションを取得または設定します。
	CodeGenerator	サービスの説明インポータによって使用されるコード ジェネレータを取得または設定します。
	ProtocolName	記述されている XML Web サービスにアクセスするために使用されるプロトコルを取得または設定します。
	Schemas	ServiceDescriptions プロパティによって使用される XmlSchemas を取得します。
	ServiceDescriptions	インポートされる ServiceDescription インスタンスのコレクションを取得します。
	Style	ServiceDescriptions 値がインポートされるときに生成されるコードのスタイル (クライアントまたはサーバー) を決定する値を取得または設定します。

参照

関連項目

ServiceDescriptionImporter クラス
System.Web.Services.Description 名前空間

ServiceDescriptionImporter メソッド

パブリック メソッド

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

	名前	説明
	AddServiceDescription	指定した ServiceDescription を、インポートされる ServiceDescriptions 値のコレクションに追加します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GenerateWebReferences	Web 参照のコレクションをコンパイルして、クライアント プロキシまたはサーバー スタブを作成します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	Import	指定した ServiceDescriptions 値をインポートします。これによって、Style プロパティで指定されたとおりにコードを生成します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ServiceDescriptionImporter クラス
System.Web.Services.Description 名前空間

ServiceDescriptionImporter メンバ

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

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

パブリック コンストラクタ

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

パブリック プロパティ

	名前	説明
	CodeGenerationOptions	コード生成のさまざまなオプションを取得または設定します。
	CodeGenerator	サービスの説明インポータによって使用されるコード ジェネレータを取得または設定します。
	ProtocolName	記述されている XML Web サービスにアクセスするために使用されるプロトコルを取得または設定します。
	Schemas	ServiceDescriptions プロパティによって使用される XmlSchemas を取得します。
	ServiceDescriptions	インポートされる ServiceDescription インスタンスのコレクションを取得します。
	Style	ServiceDescriptions 値がインポートされるときに生成されるコードのスタイル (クライアントまたはサーバー) を決定する値を取得または設定します。

パブリック メソッド

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

	名前	説明
	AddServiceDescription	指定した ServiceDescription を、インポートされる ServiceDescriptions 値のコレクションに追加します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GenerateWebReferences	Web 参照のコレクションをコンパイルして、クライアント プロキシまたはサーバー スタブを作成します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	Import	指定した ServiceDescriptions 値をインポートします。これによって、Style プロパティで指定されたとおりにコードを生成します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ServiceDescriptionImporter クラス
System.Web.Services.Description 名前空間