Azure Service Busトリガーチュートリアル - C#ライブラリの使用方法

Azure Service Busトリガー C#ライブラリとは

C#ライブラリの使用方法

環境設定

• .NET Framework 3.5以上
• Windows Azure Tools for Microsoft Visual StudioがインストールされたMicrosoft Visual Studio
• Windows Azure AppFabric SDK V1.0

使用するために必要な情報

• Azure Service Busトリガーが開始したAzure Service Busサービスへ接続するための以下の情報
  • サービス名前空間(Service Namespace)
  • サービスパス(Service Path)
  • 既定の発行者(Default Issuer)
  • 既定のキー(Default Key)
• 実行スクリプトのスクリプト入力変数に値を渡す場合、スクリプト入力変数の「変数名」および「変数型」
• 実行スクリプトのスクリプト出力変数から値を取得する場合、スクリプト出力変数の「変数名」および「変数型」

開発の流れ

1. Microsoft Visual Studio上のMicrosoft Azure C#アプリケーション(WebロールもしくはWorkerロール)で、必要なモジュールに参照を追加する
2. トリガーを発火させる処理を実装する(詳細については、「C#プログラムからの使用」を参照してください)
3. 開発したアプリケーションをMicrosoft Azure上にサービスとしてデプロイする

C#プログラムからの使用

参照設定

• AppFabricTriggerService.dll
  
  • C#ライブラリの本体です。$DATASPIDER_HOME/server/lib/ディレクトリ内に配置されています。
• Microsoft.ServiceBus.dll
  
  • Windows Azure AppFabric SDKのライブラリです。通常はC:\Program Files\Windows Azure AppFabric SDK\V1.0\Assembliesディレクトリ内に配置されています。

プログラムの流れ

1. 接続情報を指定して、AppFabricTriggerServiceのインスタンスを生成します。
2. AppFabricTriggerServiceのPutParamメソッドを使用して、スクリプト入力変数に渡すパラメータを指定します。
3. AppFabricTriggerServiceのExecuteメソッドを呼び出して、メッセージ送信を行いトリガーを発火させます。
4. Executeメソッドの返り値として、ExecutionResponseのインスタンスを取得し、スクリプト実行結果を取得します。
5. 実行に成功した場合、ExecutionResponseからスクリプト出力変数の値を取得します。
6. 実行に失敗した場合、ExecutionFailureからエラー情報を取得します。

サンプルプログラム

using System;
・・・・(中略)・・・
//usingディレクティブにC#ライブラリの名前空間を指定 
using Appresso.DataSpider.Service;
	
public class AppFabricTriggerTest 
{

	・・・・(中略)・・・
	
	public void ExecuteDataSpiderService ()
	{
		// AppFabricTriggerServiceインスタンスの生成
		AppFabricTriggerService service = new AppFabricTriggerService (
			"serviceNamespace",  // サービス名前空間(Service Namespace)の指定
			"servicePath", // サービスパス(Service Path)の指定
			"defaultIssuer", // 既定の発行者(Default Issuer)の指定
			"defaultKey");　// 既定のキー(Default Key)の指定

		// 文字列型のスクリプト入力変数「string_in」に渡すパラメータを設定
		string string_in = "文字列入力";
		service.PutParam("string_in", string_in);

		// 整数型のスクリプト入力変数「int_in」に渡すパラメータを設定
		int int_in = 200;
		service.PutParam("int_in", int_in);
		
		// 真偽値型のスクリプト入力変数「boolean_in」に渡すパラメータを設定
		bool boolean_in = True;
		service.PutParam("boolean_in", boolean_in);

		// Executeメソッドを呼び出してトリガーを発火させ、ExecutionResponseを取得する
		ExecutionResponse response = service.Execute();
		
		// ExecutionResponseから終了ステータスを取得
		int exitStatus = response.ExitStatus;
		
		// ExecutionResponseから処理に成功したかどうかを取得
		bool succeeded = response.Succeeded;
		
		if (succeeded)
		{
			// 処理が成功した場合
			
			// スクリプト出力変数の情報を持つDictionary型のインスタンスをExecutionResponseのResultsプロパティから取得
			Dictionary<string, object> results = response.Results;
			
			// 文字列型のスクリプト出力変数「string_out」から値を取得
			string string_out = (string )results["string_out"];
			
			// 整数型のスクリプト出力変数「int_out」から値を取得
			int int_out = (int)results["int_out"];
			
			// 真偽値型のスクリプト出力変数「boolean_out」から値を取得
			bool boolean_out = (bool)results["boolean_out"];
			
			・・・・(取得した値を使用した処理は中略)・・・
		}
		else
		{
			// 処理が失敗した場合
			
			// エラー情報を持つExecutionFailureインスタンスをExecutionResponseのFailureプロパティから取得
			ExecutionFailure faillure = response.Failure;
			
			// エラーのタイプを取得
			string failureType = faillure.Type;
			
			// エラーのメッセージを取得
			string failureMessage = faillure.Message;
			
			// エラーの詳細を取得
			string failureMessage = faillure.Message;
			
			・・・・(取得したエラー情報を使用した処理は中略)・・・
			
		}
	}
	・・・・(中略)・・・
}

スクリプト入力変数に値を渡すには

スクリプト入力変数の型	対応するC#の型	備考
文字列型	string
整数型	int
10進数型	decimal
日付/時間型	System.DateTime	ミリ秒より小さい桁の値は切り捨てられます。
真偽値型	bool
バイナリ型	byte[]
XML型	System.Xml.XmlDocument

スクリプト出力変数の値を取得するには

主な例外