TIBCO® メタデータエージェントフレームワーク
概要と目的
TIBCO® メタデータエージェントフレームワークを使用すると、顧客は特定のアダプタを通じて TIBCO® メタデータエージェント内の特定のデータソースタイプのサポートを実装できます。
アダプタは、特定のデータソースタイプに対して 1 つまたは複数の EBX® メタデータ管理機能を保証する個別の Java アプリケーションです。
-
データソース管理
-
メタデータの収集
-
データサンプリング
-
メタデータのプロビジョニング
-
リネージ抽出TIBCO® メタデータエージェントフレームワークには次のエレメントが含まれます。
-
特定のデータソースタイプに対して特定のメタデータ管理機能をカスタマイズするために実装する必要がある Java ベースのインターフェイス
-
機能が実装されていることを示すために使用する必要がある Java アノテーション
-
アダプタをアクティブ化し、このアダプタとサポートされているデータソースタイプ/EBX® メタデータ管理機能との関係を定義できるプロパティ
-
アダプタからエージェントに国際化されたエラーを適切に発生させるための拡張可能な例外およびエラーコード。
メタデータ抽出機能の拡張
既存のメタデータ抽出機能を拡張するには、定義されたインターフェイスコントラクトに従って Java プログラミング言語を使用してアダプタを実装する必要があります。
アダプタは次の規則に従う必要があります。
-
Java アプリケーション (jar) ファイルとしてコンパイルされる
-
登録サービスの
addAdapterInfos()メソッドを実装して、エージェントに必須の登録データを提供する -
インターフェイスコントラクトと必須のアノテーションを使用した少なくとも 1 つのメタデータ抽出サービスを実装する
-
エージェントプロパティファイルに登録される。
メタデータエージェントは Spring Boot 2.5.4 フレームワークを活用します。アダプタ実装には、サービス用の Spring アノテーション (
org.springframework.stereotype.Service) を含める必要があります。
推奨されるアダプタ プロジェクト構造
アダプタは、担当開発チームにとって快適な方法で開発できます。以下は、Java プロジェクトの Maven 依存関係管理とアーキテクチャのベストプラクティスに基づいた推奨構造です。
メインプロジェクトには、3 つのモジュールプロジェクトと 1 つの構成プロジェクトが含まれています。
| モジュール名 | 説明 |
|---|---|
| tcmd-agent-example-bundle | アダプタを 1 つの jar ファイルにアセンブルする方法を定義し、依存関係を簡単な方法で管理できるようにするバンドルプロジェクト。 |
| tcmd-agent-example-common | アダプタの共通ライブラリコード。通常、これはエラー管理フレームワーク、いくつかの共通プロパティとユーティリティ、および i18n リソースをホストします。 |
| tcmd-agent-example-conf | アダプタのプロパティと構成ファイルをホストするプロジェクトフォルダー。 |
| tcmd-agent-example-service | アダプタ内にエージェントサービスを実装するコードを作成します。 |
TIBCO® メタデータエージェントフレームワークへのアダプタの登録
TIBCO® メタデータエージェントフレームワークにアダプタを登録するには、次の手順に従う必要があります。
1. 登録サービスを実装する
アダプタの登録サービスでは、専用のエージェントインターフェイス
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterRegistrationService サービスとそのメインメソッド addAdapterInfos() を実装する必要があります。
このメソッドを使用すると、アダプタ情報オブジェクト
com.tibco.ebx.ca.tabula.shared.agent.dto.AdapterDTO を作成できます。このオブジェクトには、アダプタに関する次の情報を指定する必要があります。
| プロパティ | 説明 |
|---|---|
| name | アダプタの技術名。実装アノテーションとエージェントのプロパティ agent-adapter.active-profiles に使用する値と一致する必要があります。 |
| version | アダプタの実装バージョン。 |
| provider | 使用者の会社名。 |
| productVersion | サポートされているメタデータプロバイダーの対応するバージョン。 |
| description | EBX® に表示されるアダプタの説明。 |
2. 適切なアノテーションを付ける
TIBCO® メタデータエージェントフレームワークによって認識されるためには、実装されていると考えられる各サービスクラスに、アダプタの技術名 (エージェントのプロパティ
agent-adapter.active-profiles およびアダプタ情報オブジェクトの属性 name で提供される) を値として持つ com.tibco.ebx.ca.tabula.agent.common.annotation.MetadataAdapterProfile でアノテーションを付ける必要があります。
実装されていると考えられるサービス内の各操作には、
com.tibco.ebx.ca.tabula.agent.common.annotation.MetadataOperationImplemented のアノテーションを付ける必要があります。
3. メインエージェントのプロパティにアダプタ名とプロパティを追加する
エージェントがアダプタをロードする必要があることを示すには、次のプロパティを変更する必要があります。
#Comma-separated list of packages to scan for adapters classes agent-adapter.base.package=com.tibco.ca.tabula.agent.tdv, com.mycompany.agent #Comma separated list of profiles (corresponding to adapter technical names) agent-adapter.active-profiles=tdv,myadapter
4. アクティブプロファイルにアダプタ名を追加する
エージェントの Java 起動構成を編集して、アダプタ名をプロファイルとして追加します。
-Dspring.profiles.active=tdv,myadapter
5. アダプタ jar とオプションのプロパティをエージェントの CLASSPATH に追加します。
アダプタ jar と、オプションでコードに必要なプロパティ/構成ファイルをエージェントの
CLASSPATH に展開します。
TIBCO® メタデータエージェントのインストールの説明に従って、
application-datasources.properties ファイルで適切なデータソースタイプに対してアダプタをアクティブ化します。
主な機能の実装
アダプタによって実装できるメタデータ機能は次のとおりです。
-
データソース管理
-
メタデータの収集
-
データプロファイリング
-
データサンプリング
-
メタデータのプロビジョニング
-
リネージ抽出
一般的な実装規則
主要なメタデータ機能を実装する各カスタムサービスは、次の規則に準拠する必要があります。
-
実装すると考えられる各サービスクラスには、アダプタの技術名 (エージェントのプロパティ
agent-adapter.active-profilesおよびアダプタ情報オブジェクトの属性nameで指定) を値として持つcom.tibco.ebx.ca.tabula.agent.common.annotation.MetadataAdapterProfileでアノテーションを付ける必要があります。 -
各サービスクラスには、Spring
org.springframework.stereotype.Serviceアノテーションを付ける必要があります。 -
実装されていると考えられるサービス内の各操作には、
com.tibco.ebx.ca.tabula.agent.common.annotation.MetadataOperationImplementedのアノテーションを付ける必要があります。 -
アダプタによって作成されたタイプ
com.tibco.ebx.ca.tabula.shared.agent.landing.dto.MetadataExchangeDTOの各オブジェクトに対して、少なくともsourceId、sourceType、datasourceType、およびname属性を設定する必要があります。
データソース管理
データソース管理機能は、メタデータプロバイダーシステム内のデータソースに対する次の操作をカバーします。
-
利用可能なすべてのデータソースの読み取り
-
新しいデータソースの作成
-
既存データソースの削除
-
既存データソースの可用性の確認この機能は、
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterDatasourceManagementServiceサービスを実装することで拡張できます。
メタデータの収集
メタデータ収集機能は、メタデータプロバイダーシステムのデータソースと基礎となるリソースに対する次の操作をカバーします。
-
新しいデータソースを作成し、そのすべてのメタデータを取得
-
リソース/データソースのメタデータまたはリソース/データソースのリストを取得
-
ルートリソース/データソースの子リソースのリストを取得
この機能は、
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterHarvestingService サービスを実装することで拡張できます。
データプロファイリング
データプロファイリング情報をメタデータ交換オブジェクトに追加できます。
この機能は、
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterHarvestingService サービスのメソッド addProfilingToAssetを実装することで拡張できます。
データサンプリング
特定のデータソース/リソースのソースシステムからサンプルデータを要求できます。
この機能は、
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterSamplingService サービスを実装することで拡張できます。
メタデータのプロビジョニング
メタデータプロビジョニング機能は、メタデータプロバイダーシステム上の
パブリックスペースに既存のデータソース/リソースを提供することを目的とした操作をカバーします。
この機能を使用すると、複数の既存のデータソース/リソースに基づいて新しいデータソース/リソースを作成することもできます。
以下の操作がサポートされています。
-
メタデータのプロビジョニング (新しいパブリックソースを作成し、そこにリソースを公開)
-
すでにプロビジョニングされたメタデータリソースの変更
-
すでにプロビジョニングされたメタデータリソースの削除
-
リソースがすでにプロビジョニングされているかどうかの確認
-
指定されたリソースがプロビジョニングされたリソースのソースとしてサポートされているかどうかの確認
この機能は、
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterProvisioningService サービスを実装することで拡張できます。
リネージ抽出
ソースシステムがサポートしている場合は、リネージ情報をソースシステムから抽出できます。この情報は、メタデータ交換オブジェクトに追加し、TIBCO® メタデータエージェントを通じて {{ site.PRODUCT\_NAME\_R }} にプッシュして、テクニカルフローとして保存することもできます。
この機能は、
com.tibco.ebx.ca.tabula.agent.adapter.service.AdapterLineageService サービスを実装することで拡張できます。
例外管理
特定の例外管理フレームワークは、TIBCO® メタデータエージェントフレームワークの一部として提供されます。
このフレームワークには次のエレメントが含まれます。
-
com.tibco.ebx.ca.tabula.agent.common.adapter.exception.MetadataAdapterException: コードから TIBCO® メタデータエージェント および {{ site.PRODUCT\_NAME\_R }} に特定の例外をスローして処理するために実装する必要がある国際化例外クラス。 -
com.tibco.ebx.ca.tabula.agent.common.exception.MetadataExceptionReason: カスタム例外理由を定義するために列挙クラスによって実装されるインターフェイス。
特定の例外を実装するには、適切なコンストラクターを使用して汎用例外クラスを拡張し、
getErrorBundle() メソッドをオーバーライドしてエラーメッセージファイルの名前を返す必要があります。このファイルは、次の命名規則に従って、src/main/resources フォルダー内で使用可能にする必要があります。
<error bundle name>_<language 2 letters code>.properties
言語コードはオプションです。指定されていない場合は、バンドルは英語に適用されるものと見なされます。
例外の特定のエラー理由を追加するには、プロジェクト内に
MetadataExceptionReason インターフェイスを実装する enum を作成し、そこにエラーメッセージキーを定義する必要があります。
public enum MyMetadataExceptionReason implements MetadataExceptionReason {
AGENT_ADAPTER_ERROR("agent.adapter.error");
private MyMetadataExceptionReason(final String ckey) {
this.key = ckey;
}
private String key;
@Override
public String getKey() {
return key;
}
}
特定の例外を定義したくない場合は、クラス 'com.tibco.ebx.ca.tabula.agent.common.adapter.exception.MetadataAdapterTechnicalException' で表される TIBCO® メタデータエージェントフレームワークによって提供される一般的な技術例外を使用できます。
この例外は、文字列メッセージまたは
Throwable オブジェクトを使用してインスタンス化できます。
ロギング
現時点では、特定のログ記録フレームワークは提供されていません。
TIBCO メタデータエージェントは、slf4j ロギングフレームワークを活用して、適切なログファイルに機能メッセージを書き込みます。
一貫性を保つために、アダプタには同じフレームワークを使用し、メッセージの書き込みに
System.out.print/println を使用しないことをお勧めします。