56 Oracle BAM Webサービスの使用

Oracle BAM Webサービスは、Oracle BAMサーバーにデータを送信するOracle BAMテクノロジの一部です。この章では、Oracle BAM Webサービスの使用方法について説明します。

項目は次のとおりです。

• 第56.1項「Oracle BAM Webサービスの概要」

• 第56.2項「DataObjectOperations Webサービスの使用」

• 第56.3項「DataObjectDefinition Webサービスの使用」

• 第56.4項「ManualRuleFire Webサービスの使用」

• 第56.5項「ICommand Webサービスの使用」

56.1 Oracle BAM Webサービスの概要

Oracle BAM Webサービスを使用すると、リアルタイムのチャートやダッシュボードで使用するためのデータをOracle BAMサーバーにパブリッシュするアプリケーションを作成できます。標準のWebサービスと通信できるすべてのクライアントでは、これらのAPIを使用してOracle BAMにデータをパブリッシュできます。Oracle BAM Webサービス・インタフェースによって、Oracle BPEL Process ManagerやOracle Mediatorなどの他のコンポーネントにOracle BAMが統合され、SOAコンポジット・アプリケーションの開発が容易になります。

注意: このオプションは、複雑なメッセージ処理、データを補足するためのOracle BAMアクティブ・データ・キャッシュでの参照の実行、またはスター・スキーマを設定するための初期一括アップロードには使用できません。

Oracle BAMサーバーのデータ・オブジェクトは、Oracle BAM Webサービスを使用して利用できます。ICommand Webサービスを使用して利用できる他のメタ・オブジェクトもいくつかあります。

外部Webサービスは、Oracle BAMアラート・ルールによってコールできます。詳細は、第57.2項「アラート・ルールの作成」を参照してください。

Oracle BAMには、次に示すタイプ付きでない静的なWebサービスAPIが用意されています。

• DataObjectOperations10131を使用すると、Oracle BAM 10.1.3.xサーバー用に開発されたクライアントで、DataObjectOperationsへのWebサービス・コールをOracle BAM 11gサーバー上で実行できます。

• DataObjectOperationsByIDを使用すると、開発者は、それぞれのID(例: _Call_Center)で、データ・オブジェクトと通信できます。

• DataObjectOperationsByNameを使用すると、開発者は、それぞれの表示名(例: Call Center)で、データ・オブジェクトと通信できます。

• DataObjectDefinitionは、データ・オブジェクトの定義を取得、作成、削除および更新する操作を実行します。

• ManualRuleFireは、Oracle BAMアクティブ・スタジオで作成されたルールを起動するために他のOracle BAMサービスによって使用されます。

• ICommandは、Oracle BAMサーバーのアイテムに対して様々な操作を実行する一連のコマンドを提供する、DOSコマンドライン・ユーティリティです。ICommand Webサービスは、すべてのICommand機能をWebサービスを介して公開します。

これらのサービスは、WSILインタフェースを使用してOracle BAMサーバー内で検出できます。

56.2 DataObjectOperations Webサービスの使用

DataObjectOperations Webサービスを使用すると、データ・オブジェクト内の行に対して、挿入、更新、削除およびアップサートを実行することによって、Oracle BAMサーバーのデータ・オブジェクトを操作できます。

DataObjectOperations Webサービス・インタフェースでは、次の操作がサポートされています。

• バッチでは、データ・オブジェクトに対してバッチ操作が実行されます。バッチは、DataObjectOperationsByName Webサービスに対してはサポートされていません。

• 「削除」では、データ・オブジェクトから行が削除されます。

• 取得では、XMLペイロードの仕様ごとにデータ・オブジェクトから詳細がフェッチされます。取得はDataObjectOperationsByName Webサービスでのみ使用できます。

• 「挿入」では、データ・オブジェクトに行が追加されます。

• 「アップサート」では、データ・オブジェクトに行が存在する場合は、既存の行に新規データが挿入されます。行が存在しない場合は、新規行が作成されます。

• 「更新」では、データ・オブジェクト内の既存の行に新規データが挿入されます。

リクエスト・メッセージとレスポンス・メッセージは、使用する操作によって異なります。各Webサービスでサポートされている操作の使用方法については、E.1項「DataObjectOperations10131」、E.2項「DataObjectOperationsByName」およびE.3項「DataObjectOperationsByID」を参照してください。

56.2.1 DataObjectOperations Webサービスの使用方法

DataObjectOperations Webサービスを使用するには、Oracle JDeveloperでアプリケーションにWebサービス・プロキシを作成します。

DataObjectOperations WebサービスのWeb Services Description Language(WSDL)ファイルは、Oracle BAM Webサービスがインストールされているシステム上の次のURLで使用できます。

http://host_name:7001/OracleBAMWS/Services/DataObject/DataObjectOperations.asmx?WSDL

http://host_name:7001/OracleBAMWS/WebServices/DataObjectOperationsByID?WSDL

http://host_name:7001/OracleBAMWS/WebServices/DataObjectOperationsByName?WSDL

注意: 管理サーバー上のOracle BAM Webサービスのデフォルト・ポートは7001です。管理対象サーバーのデフォルトのポート番号は9001です。

作成したWebサービス・プロキシは、図56-1に示すように、「アプリケーション・ナビゲータ」では、プロジェクトの「アプリケーション・ソース」フォルダの下に表示されます。

図56-1 「アプリケーション・ソース」内のDataObjectOperations Webサービス・プロキシ

「図56-1 「アプリケーション・ソース」内のDataObjectOperations Webサービス・プロキシ」の説明

56.3 DataObjectDefinition Webサービスの使用

DataObjectDefinition Webサービスを使用すると、Webサービス・クライアントで、データ・オブジェクト定義を作成、更新、削除および取得できます。

DataObjectDefinition Webサービスでは、次の操作がサポートされています。

• 「作成」では、データ・オブジェクトが作成されます。詳細は、E.4.1項「作成」を参照してください。

• 「削除」では、サーバーからデータ・オブジェクトが削除されます。詳細は、E.4.2項「削除」を参照してください。

• 取得では、既存のデータ・オブジェクトの定義が返されます。詳細は、E.4.3項「取得」を参照してください。

• 「更新」では、データ・オブジェクトの定義が変更されます。詳細は、E.4.4項「更新」を参照してください。

リクエスト・メッセージとレスポンス・メッセージは、使用する操作によって異なります。詳細は、E.4項「DataObjectDefinitionの操作」を参照してください。

56.3.1 DataObjectDefinition Webサービスの使用方法

DataObjectDefinition Webサービスを使用するには、Oracle JDeveloperでアプリケーションにWebサービス・プロキシを作成します。

DataObjectDefinition WebサービスのWSDLファイルは、Oracle BAM Webサービスがインストールされているシステム上の次のURLで使用できます。

http://host_name:7001/OracleBAMWS/WebServices/DataObjectDefinition?WSDL

注意: 管理サーバー上のOracle BAM Webサービスのデフォルト・ポートは7001です。管理対象サーバーのデフォルトのポート番号は9001です。

作成したWebサービス・プロキシは、図56-2に示すように、「アプリケーション・ナビゲータ」では、プロジェクトの「アプリケーション・ソース」フォルダの下に表示されます。

図56-2 「アプリケーション・ソース」内のDataObjectDefinition Webサービス・プロキシ

「図56-2 「アプリケーション・ソース」内のDataObjectDefinition Webサービス・プロキシ」の説明

56.4 ManualRuleFire Webサービスの使用

ManualRuleFire Webサービスを使用すると、Oracle BAMサーバーでルールを起動できます。FireRuleByNameが使用可能な操作です。詳細は、E.5項「ManualRuleFireの操作」を参照してください。

56.4.1 ManualRuleFire Webサービスの使用方法

ManualRuleFire Webサービスを使用するには、Oracle JDeveloperでアプリケーションにWebサービス・プロキシを作成します。

ManualRuleFire WebサービスのWSDLファイルは、Oracle BAM Webサービスがインストールされているシステム上の次のURLで使用できます。

http://host_name:7001/OracleBAMWS/WebServices/ManualRuleFire?WSDL

注意: 管理サーバー上のOracle BAM Webサービスのデフォルト・ポートは7001です。管理対象サーバーのデフォルトのポート番号は9001です。

作成したWebサービス・プロキシは、「アプリケーション・ナビゲータ」では、プロジェクトの「アプリケーション・ソース」フォルダの下に表示されます。

56.5 ICommand Webサービスの使用

ICommandは、HTTPを介してICommand機能と通信する必要があるアプリケーション開発者用のWebサービスとして使用できます。

ICommand Webサービスには、コマンドライン・ユーティリティとほとんど同じ機能が含まれています。たとえば、次の操作に使用できます。

• データ・オブジェクトの削除

• データ・オブジェクトへの行のインポート

• レポートのエクスポート

主な相違点は、Webサービスではリモート・システム上のファイルにアクセスできないということに起因しています。そのため、importコマンドまたはexportコマンドを使用する場合に、ファイル名を渡すことができません。

かわりに、importコンテンツをインラインで渡す必要があります。同様に、exportコンテンツをインラインで受信します。

通常、importおよびexport以外のコマンドは、コマンドライン・ユーティリティの場合と同様に動作します。

ICommandで提供されているコマンドおよびパラメータの詳細は、付録G「Oracle BAM ICommandの操作とファイル・フォーマット」を参照してください。

ICommand Webサービスには、Batchと呼ばれる単一のメソッドが含まれています。これは、単一の入力パラメータを指定します。このパラメータは、G.3項「コマンド・ファイルのフォーマット」で説明されている構文で一連のコマンドが含まれている文字列です。戻り値は、G.4項「ログ・ファイルのフォーマット」で説明されているログ構文で各コマンドの実行結果が含まれている文字列です。

56.5.1 ICommand Webサービスの使用方法

ICommand WebサービスのWSDLファイルは、Report Serverがインストールされているシステムで使用できます。次のURLにあります。

http://host_name:7001/OracleBAMWS/WebServices/ICommand?WSDL

注意: 管理サーバー上のOracle BAM Webサービスのデフォルト・ポートは7001です。管理対象サーバーのデフォルトのポート番号は9001です。

例56-1 データ・オブジェクトの削除(入力)

<OracleBAMCommands>
  <Delete type="dataobject" name="/test123"/>
</OracleBAMCommands>