International Data Spaces Trustworthy and sovereign data sharing enable the data economy

2025-01-04

Data Spaces

メモ

International Data Spaces Trustworthy and sovereign data sharing enable the data economy のホワイトペーパーの概要。以下は、GenAIを用いたまとめなので内容正誤には注意が必要。

1. 国際データスペースの重要性

国際データスペース（IDS）は、信頼できるデータ共有を可能にし、データ経済の基盤を形成します。データスペースは、複数の組織間でのデータ共有を促進し、参加者間の信頼を構築するための技術的インフラを提供します。IDSAは、データスペースの基準を確立し、データの価値と信頼を維持するための枠組みを提供します【2】。

2. データ主権の擁護

IDSAは、すべての個人と組織が自分のデータを制御できる世界を目指しています。データ主権は、データの管理と責任を誰が持つかを定義し、データの使用ポリシーや契約を明確にすることが重要です。IDSAは、データコネクタを通じて、これらのルールを理解し、遵守することを支援します【3】。

3. IDSAルールブック

IDSAルールブックは、データスペース内の組織間の相互運用性を確保するためのガイドです。データスペースを構築するための基盤を提供し、信頼性を確保するための必須要素を明確にします。相互運用性は、法的、組織的、意味的、技術的なレベルで重要です【4】。

4. データコネクタの役割

データコネクタは、データスペース内の参加者を接続し、データを安全に共有するためのソフトウェアです。これにより、データの流れが円滑になり、信頼性が確保されます。コネクタは、データ交換サービスを提供し、使用ポリシーを強制します【6】。

5. IDS認証

IDS認証は、データ経済における信頼と相互運用性を実現するための重要な役割を果たします。すべてのデータエンドポイントは共通の信頼フレームワークに従い、厳格なセキュリティ基準に基づいて認証されます【7】。

6. データスペースプロトコル

データスペースプロトコル（DSP）は、データスペースの技術実装の中核を成し、参加者間の相互運用性を保証します。標準化されたプロトコルを確立し、システム間のスムーズな通信を促進します【8】。

7. オープンソースの重要性

IDSAは、オープンソースを活用して市場の採用を加速させることを目指しています。透明性と協力を促進し、持続可能なエコシステムを構築することで、データ共有ソリューションの開発を推進します【9】。

8. 標準化の重要性

標準化は、相互運用性を可能にし、技術的障壁を減少させ、貿易を促進します。IDSAは、国際的な標準化活動を通じて、データスペースの実装を支援しています【11】【12】。

9. 成功事例

IDS標準に基づく成功事例が多くの業界で見られます。モビリティデータスペースやCatena-Xなどのプロジェクトは、データの安全な共有を促進し、新しいビジネス機会を生み出しています【16】【17】。

1. モビリティデータスペース（MDS）

目的: 持続可能な交通を促進するために、モビリティサービスと気候変動への貢献を目指します。
参加者: ドイツ政府を含む200以上のステークホルダーが参加。
機能: リアルタイムのモビリティデータを利用し、交通の最適化や公共交通サービスの向上を図ります。
特徴: IDS参照アーキテクチャに基づき、データの出所と品質を保証するための条件を設定できる仕組みが整っています。

2. Catena-X

目的: 自動車産業のデータ主権とコラボレーションを促進します。
参加者: Daimler、BMW、Volkswagenなど、業界の主要企業が参加。
特長: 競争の激しい業界においても、透明で持続可能なサプライチェーンを実現することを目指します。

3. スマートコネクテッドサプライヤーネットワーク（SCSN）

目的: 高度な製造業におけるサプライチェーンの遅延を解消するために開発されました。
機能: パートナー間のコミュニケーションを促進し、重要な情報を追跡する能力を提供します。
効果: 生産性の向上とコスト削減を実現します。

4. Eona-X

目的: 移動、輸送、観光分野におけるデータ主権を促進します。
参加者: Amadeus Group、SNCF、Air Franceなどの主要企業が参加。
特徴: 複数の交通手段や観光地のデータを統合し、利用者の体験を向上させることを目指します。

10. IDSAの国際的な取り組み

IDSAは、データスペースのエコシステムを構築するために、他のデータ関連団体と協力しています。これにより、データ共有の原則を広め、国際的な協力を促進しています【13】【14】。

この要約は、IDSAの目的、活動、及びデータスペースの重要性を強調しています。

オープンソースの重要性

IDSAは、オープンソースを活用することで市場の採用を加速させることを目指しています。オープンソースは、イノベーションと協力を促進し、持続可能で多様なエコシステムを形成するための重要な要素です。IDSAのオープンソース戦略は、IDSコンポーネントの基盤を構築し、透明性、協力、コミュニティの参加を促進します。このアプローチにより、開発が迅速化し、コストが削減され、IDSソリューションが関連性を持ち続けることができます【9】。

また、IDSAはEclipse Foundationと協力し、Eclipse Dataspace Working Group（EDWG）を設立しています。この協力により、データスペースのための普遍的な標準とソフトウェアコンポーネントの開発が加速されます。IDSAは、オープンソースの開発者ネットワークを活用し、信頼できるデータ共有フレームワークの構築を進めています【9】。

https://dataspace.eclipse.org/become-a-member/

Eclipse Foundationの具体的なメンバーシップ費用についての情報は、以下の通りです。

Eclipse Foundationのメンバーシップ費用

メンバーシップレベル	年会費	主な特典
戦略的メンバー (Strategic Members)	$50,000	理事会への席、アーキテクチャ評議会への席、戦略的メンバー専用プログラムへのアクセス
貢献メンバー (Contributing Members)	$25,000	理事会での代表権、一般集会への参加と投票、Eclipse Working Groupsへの参加
アソシエイトメンバー (Associate Members)	$5,000	公開メールリストへの参加、一般集会への出席
コミッターメンバー (Committer Members)	無料または低額	プロジェクトへの貢献

具体的な金額や詳細は、Eclipse Foundationの公式サイトにて確認できます。特に、最新の情報は公式サイトでの確認が推奨されます。詳細については、以下のリンクを参照してください： - Eclipse Foundation Membership Levels & Fees [1] - Eclipse Foundation FAQ [2]

データスペースレーダーによる影響の推進

データスペースレーダーは、データスペースの取り組みを迅速に収集し、カタログ化するためのツールです。このツールは、世界中のデータスペースイニシアティブを可視化し、100を超えるエントリーが記録されています。

主な機能と目的

パノラマビューの提供: データスペースレーダーは、さまざまなセクターや地域、開発段階におけるデータスペースの取り組みを示します。これにより、参加者はどのようなイニシアティブが存在するかを把握できます。
成功事例の紹介: ユーザーフレンドリーなオンラインフォームを通じて収集された成功事例を紹介し、他のプロジェクトチームが最適な技術を選択する際のガイドとして機能します。
評価基盤の提供: データスペースレーダーは、ビジネス、組織、技術の側面から各イニシアティブの開発段階を評価し、包括的な評価の基盤を形成します。

参考

Eclipse Dataspace Protocol Unofficial draft 13 Dec. 2024

2025-01-02

Data Spaces

Data Spaces, Eclipase

メモ
参考

メモ

このメモは、2024/12/13時点の GitHub上で公開されているEclipase Dataspace Protocolのドラフトの内容をまとめたものである。生成AIにて概要を出力したので内容の正誤については注意されたし。

このドキュメントでは、Dataspace Protocolについて説明します。これは、使用制御によって管理され、Webテクノロジーに基づくエンティティ間で相互運用可能なデータ共有を促進するように設計された一連の仕様です。これらの仕様では、Dataspaceと呼ばれる技術システムの連合の一部として、エンティティがデータを公開し、契約を交渉し、データにアクセスするために必要なスキーマとプロトコルを定義しています。

この仕様の目的

この仕様の目的は、データ共有を容易にするために、データの提供方法を定義することです。

データセットがDCATカタログとしてどのように展開され、使用制御がODRLポリシーとしてどのように表現されるか。 [3]
データの使用を規定する契約がどのように構文的に表現され、電子的に交渉されるか。 [3]
転送プロセスプロトコルを使用してデータセットにどのようにアクセスするか。 [3]

データスペースプロトコルの主な概念

データスペース: エンティティ間での相互運用可能なデータセット共有を促進する一連の技術サービス。 [6]
参加者: データセットを提供および/または消費するデータスペースメンバー。 [6]
参加者エージェント: データセットを提供する参加者に代わって操作を実行するテクノロジーシステム。 [6]
カタログ: プロバイダー参加者によってアドバタイズされる、データセットとそのオファーを表すエントリの集合。 [6]
契約交渉: データセットの利用規約を定義する契約について、プロバイダーとコンシューマーの間で行われる一連のインタラクション。 [6][8]
転送プロセス: 契約の条件に基づいてデータセットへのアクセスを提供する、プロバイダーとコンシューマーの間の一連のインタラクション。 [7][8]

データスペースプロトコルは、次のドキュメントで構成されています。

データスペースモデルとデータスペース用語集のドキュメント。
HTTPSでの共通機能とそのバインディング。
カタログプロトコルとカタログHTTPSバインディングのドキュメント。
契約交渉プロトコルと契約交渉HTTPSバインディングのドキュメント。
転送プロセスプロトコルと転送プロセスHTTPSバインディングのドキュメント。 [3]

データスペースプロトコルは、データ転送プロセス自体をカバーしていません。 [4]

相互運用性を確保するために、データスペースプロトコルでは、参加者が互いのサポートされているバージョンを確実に発見できるようにする必要があります。 [9]

カタログプロトコル

カタログプロトコルは、コンシューマーが抽象的なメッセージ交換形式を使用してカタログサービスからカタログを要求する方法を定義します。 [10]

契約交渉プロトコル

契約交渉（CN）には、使用契約に基づいて1つ以上のデータセットを提供するプロバイダーと、データセットを要求するコンシューマーの2つの当事者が関与します。 [18]

転送プロセスプロトコル

転送プロセス（TP）には、使用ポリシーに基づいて1つ以上のデータセットを提供するプロバイダーと、データセットを要求するコンシューマーの2つの当事者が関与します。 [29]

参考

GitHub上で公開されているEclipase Dataspace Protocolのドラフト

Business model paper by IDSA

2025-01-02

Data Spaces

Business Model, Data Spaces

メモ
参考

メモ

はじめに

本報告書は、International Data Spaces Association（IDSA）が2024年11月に発表したポジションペーパーの分析に基づいています。

IDSA releases new position paper Data Spaces Business Models

以下、生成AIによりポイントを書き出しました。内容の正誤についてはご注意くださいませ。

背景と目的

データスペースの採用が進む中、ビジネスモデルの確立が課題
技術的な概念から実践的なビジネスモデルへの移行が必要
関係者間の共通理解と効果的なコミュニケーションの基盤構築

主要な発見

データスペースのビジネスモデルには単一の解決策は存在しない
成功には3つの重要な特性が必要：
- 協調型（Collaborative）
- マルチサイド型（Multi-sided）
- 進化型（Evolving）
初期段階での公的資金の重要性と、自己持続可能なモデルへの移行の必要性

セクション1：データスペースのビジネスモデルの特徴

1.1 ビジネスモデルの基本概念

定義: 「組織が価値を創造し、提供し、捕捉する方法の説明」（Alex Osterwalder）
重要な構成要素:
1. WHAT：市場に提供する価値提案
2. WHO：価値提案を市場に提供する主体
3. HOW：価値提案の市場への提供方法
4. TO WHOM：価値提案の対象顧客
5. BALANCE：コストと収益のバランス

1.2 データスペース固有の特性

データの非競合性：
- 同時に複数の利用が可能
- 使用しても価値が減少しない
分散型システムの特徴：
- データ主権の確保
- 相互運用性の実現
- 信頼性の担保

セクション2：実例分析

2.1 モビリティデータスペース（MDS）

背景

ドイツ政府主導の取り組み
2019年に開始
約200の参加組織を獲得

ビジネスモデルの特徴

価値提案：
- 安全な分散型データマーケットプレイス
- 欧州基準に準拠したデータ共有プラットフォーム
収益モデル：
- 初期：公的資金と株主出資
- 将来：データ取引からの収益

具体的なユースケース：

1. Pay as you drive保険
   - 保険会社とOEMの協力
   - 実際の車両使用データに基づく保険料設定
2. 都市モビリティ最適化
   - リアルタイム交通データの活用
   - デジタルツインへの統合

2.2 Catena-X

背景

自動車産業のサプライチェーン最適化
主要自動車メーカーの参加（BMW、VW、Ford、Renaultなど）

ビジネスモデルの特徴

運営構造：
- Cofinity-X（運営会社）の設立
- 参加企業のオンボーディング管理

ユースケース一覧：

1. 製品カーボンフットプリント追跡
2. バッテリー・製品パスポート
3. サプライチェーンレジリエンス
4. 部品トレーサビリティ
5. マスターデータ管理

2.3 Smart Connected Supplier Network（SCSN）

背景

2015年開始の応用研究プロジェクト
オランダの製造業サプライチェーン向け
400以上の製造企業と11のITサービスプロバイダーが参加

ビジネスモデルの特徴

価値提案：
- 管理負担の軽減
- 顧客要求への迅速な対応
- データ処理の自動化
収益モデル：
- 接続エンドユーザーごとの固定料金
- ITサービスプロバイダー経由の収益

セクション3：成功要因の分析

3.1 共通する成功要因

段階的アプローチ
- 初期：公的資金活用
- 成長期：参加者拡大
- 成熟期：自己持続的モデル

エコシステムの構築

- データ提供者
- データ消費者
- サービスプロバイダー
- 技術プロバイダー

価値創造の明確化
- 経済的価値
- 社会的価値
- 規制遵守価値

結論

データスペースの成功には、技術的側面とビジネスモデルの両立が不可欠
初期段階での公的支援と、長期的な自己持続性のバランスが重要
参加者それぞれの価値創造を明確にし、適切なインセンティブ設計が必要

今後の展望

より多様なユースケースの開発
産業間連携の促進
グローバルな標準化の進展

「データスペースのビジネスモデルは単一ではなく、状況に応じて進化する必要がある」 ― IDSA Position Paper, 2024

参考

IDSA releases new position paper Data Spaces Business Models

MVD_of_EDC

2024-12-21

Dataspace ConnectorEclipse Dataspace Components

Dataspace Connector, EDC, IDS

メモ
- Eclipse Dataspace Componentsのセットアップ
- 動作確認
参考

メモ

MVDを用いた動作確認用のメモ

Eclipse Dataspace Componentsのセットアップ

まず、Eclipse Dataspace Components（EDC）をセットアップします。EDCは、データスペースにおけるデータ連携を実現するためのフレームワークです。以下の手順でEDCをセットアップします。

準備

必要環境に必要となる環境が書いてある。

Docker
KinD (other cluster engines may work as well - not tested!)
Terraform
JDK 17+
Git
a POSIX compliant shell
Postman (to comfortably execute REST requests)
openssl, optional, but required to regenerate keys
newman (to run Postman collections from the command line)
not needed, but recommended: Kubernetes monitoring tools like K9s

Docker

Docker Desktop

kind

kindのインストール方法

JDK

JDK17をインストール

Postman

Postmanのダウンロード

openssl

1	sudo apt install openssl

newman

npmのインストールから必要

1
2
3

sudo apt install nodejs npm n
sudo n stable
sudo npm install -g newman

ソースコードのクローン

今回はMVDを用います。

1 2	git clone https://github.com/eclipse-edc/MinimumViableDataspace.git cd MinimumViableDataspace

公式サイトの環境構成図

ビルドと起動

k8s上で各種サービスを起動する。

ビルド

1 2	./gradlew build ./gradlew -Ppersistence=true dockerize

kind (k8s) 環境起動

# Create the cluster
kind create cluster -n mvd --config deployment/kind.config.yaml
# Load docker images into KinD
kind load docker-image controlplane:latest dataplane:latest identity-hub:latest catalog-server:latest sts:latest -n mvd

# 確認
docker ps
CONTAINER ID   IMAGE                  COMMAND                   CREATED         STATUS         PORTS                                                                 NAMES
b7f31408c498   kindest/node:v1.27.3   "/usr/local/bin/entr…"   2 minutes ago   Up 2 minutes   0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 127.0.0.1:32825->6443/tcp   mvd-control-plane

ingress NGINXコントローラをk8s上にデプロイ

# Deploy an NGINX ingress
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/static/provider/kind/deploy.yaml

# Wait for the ingress controller to become available
kubectl wait --namespace ingress-nginx \
  --for=condition=ready pod \
  --selector=app.kubernetes.io/component=controller \
  --timeout=90s

今回のMVD環境をデプロイ


# Deploy the dataspace, type 'yes' when prompted
cd deployment
terraform init
terraform apply

確認

1	kubectl get pods --namespace mvd

結果

NAME                                                   READY   STATUS    RESTARTS   AGE
consumer-controlplane-68c4696c57-2qmh2                 1/1     Running   0          55s
consumer-dataplane-75d79bfd56-t5mt2                    1/1     Running   0          39s
consumer-identityhub-545fdb579c-df6bq                  1/1     Running   0          55s
consumer-postgres-687484545b-sp8xr                     1/1     Running   0          96s
consumer-sts-778bb7bb44-kfqxp                          1/1     Running   0          70s
consumer-vault-0                                       1/1     Running   0          95s
dataspace-issuer-server-7ff68bd8b4-qh7c7               1/1     Running   0          96s
provider-catalog-server-58b67bdb89-nxtvq               1/1     Running   0          54s
provider-identityhub-bb68bfcf4-bv42v                   1/1     Running   0          55s
provider-manufacturing-controlplane-86bdd7c967-b6r7h   1/1     Running   0          54s
provider-manufacturing-dataplane-7d66445bf8-dp24n      1/1     Running   0          39s
provider-postgres-7fd78d95b8-x2kzd                     1/1     Running   0          96s
provider-qna-controlplane-dc894c5ff-qxcd7              1/1     Running   0          55s
provider-qna-dataplane-8574c764fd-t2x8z                1/1     Running   0          39s
provider-sts-64cd87f4f6-n5cvq                          1/1     Running   0          70s
provider-vault-0                                       1/1     Running   0          95s

構成

Consumer
- コントロールプレーン
- データプレーン
- アイデンティティ・ハブ
- PostgreSQLサーバ
- Vault
Provider
- カタログ
- QNAのコントロールプレーンとデータプレーン
- Manufacturingのコントロールプレーンとデータプレーン
- アイデンティティ・ハブ
- PostgreSQLサーバ
- Vault

データの流し込み

プロジェクト直下の、seed-k8s.shを使うとデータを流したりできる。

1	bash seed-k8s.sh

以下、内容を確認。

seed-k8s.shでは、Postman（Newman）を使って、コネクタに各種データを登録するなどしている。例えば以下の通り。

seed-k8s.sh:23

echo "Seed data to 'provider-qna' and 'provider-manufacturing'"
for url in 'http://127.0.0.1/provider-manufacturing/cp' 'http://127.0.0.1/provider-qna/cp'
do
  newman run \
    --folder "Seed" \
    --env-var "HOST=$url" \
    ./deployment/postman/MVD.postman_collection.json
done

上記の newman コマンドの引数に与えられているファイル deployment/postman/MVD.postman_collection.json にPostman（Newman）用のコンフィグファイルがある。 newmanコマンドのfolderオプションにある通り、今回は「Seed」フォルダ以下の内容を実行する。なお、この登録処理は以下の両方のホストに実施される。 * provider-qna * provider-manufacturing

行われる処理は以下。

アセット登録
- asset-1
- asset-2
ポリシー登録
- require-membership
- require-dataprocessor
- require-sensitive
コントラクト登録
- member-and-dataprocessor-def
  - アクセスポリシーは require-membership
  - コントラクトポリシーは require-dataprocessor
  - 対象アセットは asset-1
- sensitive-only-def
  - アクセスポリシーは require-membership
  - コントラクトポリシーは require-sensitive
  - 対象アセットは asset-2

続いて、スクリプトにある通り、deployment/postman/MVD.postman_collection.json の Seed Catalog Server フォルダ以下が実行される。対象ホストは、 provider-catalog-server 。

seed-k8s.sh:35

echo "Create linked assets on the Catalog Server"
newman run \
  --folder "Seed Catalog Server" \
  --env-var "HOST=http://127.0.0.1/provider-catalog-server/cp" \
  --env-var "PROVIDER_QNA_DSP_URL=http://provider-qna-controlplane:8082" \
  --env-var "PROVIDER_MF_DSP_URL=http://provider-manufacturing-controlplane:8082" \
  ./deployment/postman/MVD.postman_collection.json

カタログアセット登録
- linked-asset-provider-qna
- linked-asset-provider-manufacturing
アセット登録
- normal-asset-1
ポリシー登録
- require-membership
コントラクト定義登録
- membership-required-def

スクリプトを実行すると以下のような結果が得られる。

Seed data to 'provider-qna' and 'provider-manufacturing'          
newman                                                                                                  
                                                                                                        
MVD+IATP                                                                                                
                                                                                                        
❏ Seed                                                                                                  
↳ Create Asset 1                                                                                        
  POST http://127.0.0.1/provider-manufacturing/cp/api/management/v3/assets [200 OK, 331B, 66ms]
  ✓  Status is OK or conflict                                                                           
                                                                                                        
↳ Create Asset 2                                                                                        
  POST http://127.0.0.1/provider-manufacturing/cp/api/management/v3/assets [200 OK, 331B, 23ms]         
  ✓  Status is OK or conflict                                                                           
                                                                                                        
↳ Create Membership Policy                                                                              
  POST http://127.0.0.1/provider-manufacturing/cp/api/management/v3/policydefinitions [200 OK, 342B, 71ms]
  ✓  Status is OK or conflict                             

(snip)

┌─────────────────────────┬───────────────────┬──────────────────┐
│                         │          executed │           failed │
├─────────────────────────┼───────────────────┼──────────────────┤
│              iterations │                 1 │                0 │
├─────────────────────────┼───────────────────┼──────────────────┤
│                requests │                 7 │                0 │
├─────────────────────────┼───────────────────┼──────────────────┤
│            test-scripts │                14 │                0 │
├─────────────────────────┼───────────────────┼──────────────────┤
│      prerequest-scripts │                21 │                0 │
├─────────────────────────┼───────────────────┼──────────────────┤
│              assertions │                 7 │                0 │
├─────────────────────────┴───────────────────┴──────────────────┤
│ total run duration: 466ms                                      │
├────────────────────────────────────────────────────────────────┤
│ total data received: 1.45kB (approx)                           │
├────────────────────────────────────────────────────────────────┤
│ average response time: 34ms [min: 19ms, max: 71ms, s.d.: 21ms] │
└────────────────────────────────────────────────────────────────┘

コンシューマとプロバイダの登録

続いて、コンシューマ登録。

seed-k8s.sh:49

echo "Create consumer participant"
CONSUMER_CONTROLPLANE_SERVICE_URL="http://consumer-controlplane:8082"
CONSUMER_IDENTITYHUB_URL="http://consumer-identityhub:7082"
DATA_CONSUMER=$(jq -n --arg url "$CONSUMER_CONTROLPLANE_SERVICE_URL" --arg ihurl "$CONSUMER_IDENTITYHUB_URL" '{
           "roles":[],
           "serviceEndpoints":[
             {
                "type": "CredentialService",
                "serviceEndpoint": "\($ihurl)/api/presentation/v1/participants/ZGlkOndlYjpjb25zdW1lci1pZGVudGl0eWh1YiUzQTcwODM6Y29uc3VtZXI=",
                "id": "consumer-credentialservice-1"
             },
             {
                "type": "ProtocolEndpoint",
                "serviceEndpoint": "\($url)/api/dsp",
                "id": "consumer-dsp"
             }
           ],
           "active": true,
           "participantId": "did:web:consumer-identityhub%3A7083:consumer",
           "did": "did:web:consumer-identityhub%3A7083:consumer",
           "key":{
               "keyId": "did:web:consumer-identityhub%3A7083:consumer#key-1",
               "privateKeyAlias": "did:web:consumer-identityhub%3A7083:consumer#key-1",
               "keyGeneratorParams":{
                  "algorithm": "EC"
               }
           }
       }')

curl --location "http://127.0.0.1/consumer/cs/api/identity/v1alpha/participants/" \
--header 'Content-Type: application/json' \
--header "x-api-key: $API_KEY" \
--data "$DATA_CONSUMER"

プロバイダ登録

echo "Create provider participant"

PROVIDER_CONTROLPLANE_SERVICE_URL="http://provider-catalog-server-controlplane:8082"
PROVIDER_IDENTITYHUB_URL="http://provider-identityhub:7082"

DATA_PROVIDER=$(jq -n --arg url "$PROVIDER_CONTROLPLANE_SERVICE_URL" --arg ihurl "$PROVIDER_IDENTITYHUB_URL" '{
           "roles":[],
           "serviceEndpoints":[
             {
                "type": "CredentialService",
                "serviceEndpoint": "\($ihurl)/api/presentation/v1/participants/ZGlkOndlYjpwcm92aWRlci1pZGVudGl0eWh1YiUzQTcwODM6cHJvdmlkZXI=",
                "id": "provider-credentialservice-1"
             },
             {
                "type": "ProtocolEndpoint",
                "serviceEndpoint": "\($url)/api/dsp",
                "id": "provider-dsp"
             }
           ],
           "active": true,
           "participantId": "did:web:provider-identityhub%3A7083:provider",
           "did": "did:web:provider-identityhub%3A7083:provider",
           "key":{
               "keyId": "did:web:provider-identityhub%3A7083:provider#key-1",
               "privateKeyAlias": "did:web:provider-identityhub%3A7083:provider#key-1",
               "keyGeneratorParams":{
                  "algorithm": "EC"
               }
           }
       }')

curl --location "http://127.0.0.1/provider/cs/api/identity/v1alpha/participants/" \
--header 'Content-Type: application/json' \
--header "x-api-key: $API_KEY" \
--data "$DATA_PROVIDER"

上記の通り、DIDを登録している。

成功すると以下のようなメッセージが見られる。

(snip)

Create consumer participant                                                                             
{"apiKey":"ZGlkOndlYjpjb25zdW1lci1pZGVudGl0eWh1YiUzQTcwODM6Y29uc3VtZXI=.TfDP+lAgK+GUb7f+dNSvU9WKpZPNV1zZ/YJ8gNoNlrI3zZkcrg8b7dWAYMYD+k3qOoVdp+ZAE3C5fHWgmsQtww==","clientId":"did:web:consumer-identityhub%3A708
3:consumer","clientSecret":"IMyZ5gqsnXihiftx"}                                                          
                                                                                                        
Create provider participant                                                                             
{"apiKey":"ZGlkOndlYjpwcm92aWRlci1pZGVudGl0eWh1YiUzQTcwODM6cHJvdmlkZXI=.h7Ta9GRuNSOrD7I/BS681E7OsvsX/YEpDrz/Mj+1nJxG3xAFtwTGCFP0qF/QxWdZ/aJvi7ywehpAu/Cg/Yi37w==","clientId":"did:web:provider-identityhub%3A708
3:provider","clientSecret":"P751oqFsm4npVkai"}

動作確認

READMEの「7. Executing REST requests using Postman」を参考に実施。

変数にはローカル環境用とKubernetes環境用があるので、今回はkubernetes環境用を使用。

deployment/postman/MVD K8S.postman_environment.json

Postmanでインポートすると以下のように環境が見える。

続いて、collectionをインポートする。

deployment/postman/MVD K8S.postman_collection.json

コレクションをインポートすると、以下のように各種リクエストをPostmanから送れるようになる。

カタログ

以下のように、環境をMVD K8Sに変更（右上）し、Get Cached Catalogsを実行すると、カタログ情報が見え、先程登録したasset-1とasset-2の情報が見えるはず。

asset-1の場合は以下のような感じ。

{
    "@id": "fcc9cefa-c31e-4155-ad59-35294044cc6d",
    "@type": "dcat:Catalog",
    "dcat:dataset": [
        {
            "@id": "asset-1",
            "@type": "dcat:Dataset",
            "odrl:hasPolicy": {
                "@id": "bWVtYmVyLWFuZC1kYXRhcHJvY2Vzc29yLWRlZg==:YXNzZXQtMQ==:OThhZGM3OGQtZDM1Ny00MDQwLTlhYmUtYzI3YTIzYTMyNmUz",
                "@type": "odrl:Offer",
                "odrl:permission": [],
                "odrl:prohibition": [],
                "odrl:obligation": {
                    "odrl:action": {
                        "@id": "odrl:use"
                    },
                    "odrl:constraint": {
                        "odrl:leftOperand": {
                            "@id": "DataAccess.level"
                        },
                        "odrl:operator": {
                            "@id": "odrl:eq"
                        },
                        "odrl:rightOperand": "processing"
                    }
                }
            },
            "dcat:distribution": [
                {
                    "@type": "dcat:Distribution",
                    "dct:format": {
                        "@id": "HttpData-PULL"
                    },
                    "dcat:accessService": {
                        "@id": "6cccbc00-9fa5-4f99-a2d9-524d2881f72f",
                        "@type": "dcat:DataService"
                    }
                },
                {
                    "@type": "dcat:Distribution",
                    "dct:format": {
                        "@id": "HttpData-PUSH"
                    },
                    "dcat:accessService": {
                        "@id": "6cccbc00-9fa5-4f99-a2d9-524d2881f72f",
                        "@type": "dcat:DataService"
                    }
                }
            ],
            "description": "This asset requires Membership to view and negotiate.",
            "id": "asset-1"
        },

README通り、今回はプロバイダのQ&A departmentに着目する。エンドポイント情報が、上記のアセット情報の直後にあるのを見つける。

"dcat:service": {
    "@id": "6cccbc00-9fa5-4f99-a2d9-524d2881f72f",
    "@type": "dcat:DataService",
    "dcat:endpointDescription": "dspace:connector",
    "dcat:endpointUrl": "http://provider-qna-controlplane:8082/api/dsp",
    "dcat:endpointURL": "http://provider-qna-controlplane:8082/api/dsp"
},

それとアセットのIDを確認しておく、odrl:hasPolicy.@idにある。今回の例だと、

asset-1

"@id": "asset-1",
"@type": "dcat:Dataset",
"odrl:hasPolicy": {
    "@id": "bWVtYmVyLWFuZC1kYXRhcHJvY2Vzc29yLWRlZg==:YXNzZXQtMQ==:OThhZGM3OGQtZDM1Ny00MDQwLTlhYmUtYzI3YTIzYTMyNmUz",

asset-2 は一旦省略

コントラクトネゴシエーション

先の手順で確認した、asset-1のIDを変数に設定する。（実際には、各自の値を使用すること）

これは、リクエストボディの以下に用いられる。

{
    "@context": [
        "https://w3id.org/edc/connector/management/v0.0.1"
    ],
    "@type": "ContractRequest",
    "counterPartyAddress": "{{PROVIDER_DSP_URL}}/api/dsp",
    "counterPartyId": "{{PROVIDER_ID}}",
    "protocol": "dataspace-protocol-http",
    "policy": {
        "@type": "Offer",
        "@id": "{{POLICY_ID_ASSET_1}}",
        "assigner": "{{PROVIDER_ID}}",
        "permission": [],
        "prohibition": [],
        "obligation": {
            "action": "use",
            "constraint": {
                "leftOperand": "DataAccess.level",
                "operator": "eq",
                "rightOperand": "processing"
            }
        },
        "target": "asset-1"
    },
    "callbackAddresses": []
}

続いて、initiate negotiationを実行する。

レスポンスが見られるはず。ただし、この状態ではまだコントラクトネゴシエーションを開始しただけ。状況確認が必要。

状況の確認

続いて、Get Contract Negotiationsを実行する。

ステータスがFINALIZEDになっていることがわかる。今回は、1回実行しただけなので、以下のとおりだが、複数回実行するとそのぶんだけ並ぶ。

[
    {
        "@type": "ContractNegotiation",
        "@id": "378b9249-b869-426f-b224-7879d358d2a1",
        "type": "CONSUMER",
        "protocol": "dataspace-protocol-http",
        "state": "FINALIZED",
        "counterPartyId": "did:web:provider-identityhub%3A7083:provider",
        "counterPartyAddress": "http://provider-qna-controlplane:8082/api/dsp",
        "callbackAddresses": [],
        "createdAt": 1737304019738,
        "contractAgreementId": "59b8c0b1-a9b1-4b83-b85d-715758941595",
        "@context": {
            "@vocab": "https://w3id.org/edc/v0.0.1/ns/",
            "edc": "https://w3id.org/edc/v0.0.1/ns/",
            "odrl": "http://www.w3.org/ns/odrl/2/"
        }
    }
]

上記からcontractAgreementId がわかる。59b8c0b1-a9b1-4b83-b85d-715758941595である。このあとのデータ転送において利用する。

トランスファーの初期化

Initiate Transferを実行するが、その際のリクエストボディは以下の通り。

{
    "@context": [
        "https://w3id.org/edc/connector/management/v0.0.1"
    ],
    "assetId": "asset-1",
    "counterPartyAddress":  "{{PROVIDER_DSP_URL}}/api/dsp",
    "connectorId": "{{PROVIDER_ID}}",
    "contractId": "{{CONTRACT_AGREEMENT_ID}}",
    "dataDestination": {
        "type": "HttpProxy"
    },
    "protocol": "dataspace-protocol-http",
    "transferType": "HttpData-PULL"
}

上記の、CONTRACT_AGREEMENT_IDに渡す値を先ほど控えた値に書き換えて、Initiate Transferを実行する。先程控えておいた値にする。各自の値を使用すること。

戻りは以下のような内容。

{
    "@type": "IdResponse",
    "@id": "0278e81e-5dea-4ab7-876f-60cd8a202e09",
    "createdAt": 1737304134741,
    "@context": {
        "@vocab": "https://w3id.org/edc/v0.0.1/ns/",
        "edc": "https://w3id.org/edc/v0.0.1/ns/",
        "odrl": "http://www.w3.org/ns/odrl/2/"
    }
}

これでトランスファーの処理が開始された。ただし、実際のデータ転送が始まったわけではない。今回は、HttpData-PULLプロトコルを用いることになっており、そのためには実際のデータを取得するためのエンドポイントとアクセスキーを取得しないとならない。

EDR（EndpointDataReference）取得

Get cached EDRsを実行する。特に変数設定などは不要。

[
    {
        "@id": "0278e81e-5dea-4ab7-876f-60cd8a202e09",
        "@type": "EndpointDataReferenceEntry",
        "providerId": "did:web:provider-identityhub%3A7083:provider",
        "assetId": "asset-1",
        "agreementId": "59b8c0b1-a9b1-4b83-b85d-715758941595",
        "transferProcessId": "0278e81e-5dea-4ab7-876f-60cd8a202e09",
        "createdAt": 1737304136114,
        "contractNegotiationId": "378b9249-b869-426f-b224-7879d358d2a1",
        "@context": {
            "@vocab": "https://w3id.org/edc/v0.0.1/ns/",
            "edc": "https://w3id.org/edc/v0.0.1/ns/",
            "odrl": "http://www.w3.org/ns/odrl/2/"
        }
    }
]

今回は有効なEDRが1個なので上記の通り。 EDRのIDがわかる。0278e81e-5dea-4ab7-876f-60cd8a202e09

アクセストークンの取得

先程確認したEDRのIDを用いて、EDRを取得する。

{
    "@type": "DataAddress",
    "type": "https://w3id.org/idsa/v4.1/HTTP",
    "endpoint": "http://provider-qna-dataplane:11002/api/public",
    "authType": "bearer",
    "endpointType": "https://w3id.org/idsa/v4.1/HTTP",
    "authorization": "eyJraWQiOiJkaWQ6d2ViOnByb3ZpZGVyLWlkZW50aXR5aHViJTNBNzA4Mzpwcm92aWRlciNrZXktMSIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJkaWQ6d2ViOnByb3ZpZGVyLWlkZW50aXR5aHViJTNBNzA4Mzpwcm92aWRlciIsImF1ZCI6ImRpZDp3ZWI6Y29uc3VtZXItaWRlbnRpdHlodWIlM0E3MDgzOmNvbnN1bWVyIiwic3ViIjoiZGlkOndlYjpwcm92aWRlci1pZGVudGl0eWh1YiUzQTcwODM6cHJvdmlkZXIiLCJpYXQiOjE3MzczMDQxMzU3OTQsImp0aSI6IjI3Y2Y0ODFlLTQ5YWYtNDI0YS1iNjc5LTk2YzQ4MmY4ODAyNyJ9.whzgJzBy9ydxontusqowd_wG33KjSfzjxqXxb600csDUdrGHFl45CEQtbRdOfSvffjQTaincEKZpAovS9b2gqg",
    "@context": {
        "@vocab": "https://w3id.org/edc/v0.0.1/ns/",
        "edc": "https://w3id.org/edc/v0.0.1/ns/",
        "odrl": "http://www.w3.org/ns/odrl/2/"
    }
}

上記の通り、エンドポイント情報とアクセストークが得られた。

(snip)
    "endpoint": "http://provider-qna-dataplane:11002/api/public",
(snip)
    "authorization": "eyJraWQiOiJkaWQ6d2ViOnByb3ZpZGVyLWlkZW50aXR5aHViJTNBNzA4Mzpwcm92aWRlciNrZXktMSIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJkaWQ6d2ViOnByb3ZpZGVyLWlkZW50aXR5aHViJTNBNzA4Mzpwcm92aWRlciIsImF1ZCI6ImRpZDp3ZWI6Y29uc3VtZXItaWRlbnRpdHlodWIlM0E3MDgzOmNvbnN1bWVyIiwic3ViIjoiZGlkOndlYjpwcm92aWRlci1pZGVudGl0eWh1YiUzQTcwODM6cHJvdmlkZXIiLCJpYXQiOjE3MzczMDQxMzU3OTQsImp0aSI6IjI3Y2Y0ODFlLTQ5YWYtNDI0YS1iNjc5LTk2YzQ4MmY4ODAyNyJ9.whzgJzBy9ydxontusqowd_wG33KjSfzjxqXxb600csDUdrGHFl45CEQtbRdOfSvffjQTaincEKZpAovS9b2gqg",
(snip)

データの取得

先程確認したトークンを用いてデータを取得する。

[
    {
        "userId": 1,
        "id": 1,
        "title": "delectus aut autem",
        "completed": false
    },
    {
        "userId": 1,
        "id": 2,
        "title": "quis ut nam facilis et officia qui",
        "completed": false
    },
    {
        "userId": 1,
        "id": 3,
        "title": "fugiat veniam minus",
        "completed": false
    },
    {
(snip)

(wip)

参考

Data Governance part of Global Digital Compact

2024-12-07

Data Governance

Data Governance, Data Spaces

メモ
参考

メモ

Global Digital Compact (United Nation) に掲載されている国連のGlobal Digital Compact資料のうち、データガバナンスに関する箇所を軽く解説。

参考

Global Digital Compact (United Nation)

Trouble using Docker Desktop and docker

2024-11-04

Docker

メモ
参考

メモ

Ubuunu22で、Docker Desktopとディストリ向けパッケージのDockerを混在させたときにトラブったので備忘録。ひとまず、Contextの指定を忘れないように。（自分向けメモ）

# コンテキストの確認
docker context ls
# コンテキスト切り替え
docker context use <任意のコンテキスト>

なお、DOCKER_HOSTの環境変数にも注意。うっかり、なにかの名残で指定していることがあるので。

参考

Trouble about Qemu when I use minikube

2024-11-04

KubenetesMinikube

Kubenetes, Minikube

メモ
参考

メモ

Problems detected in kubelet #17638にも記載されているが、Ubuntu22上でminikubeを実行していた際、minikube serviceを利用するときに以下のエラーが生じた。

1	MK_UNIMPLEMENTED が原因で終了します: minikube サービスは現在、QEMU 上のビルトインネットワークでは実装されていません

1	Exiting due to MK_UNIMPLEMENTED: minikube service is not currently implemented with the builtin network on QEMU

ひとまず、Dockerをドライバとして使用することにした。

# 既存のクラスタを破棄
minikube delete
# dockerを利用するよう指定して起動
minikube start --driver=docker

参考

Problems detected in kubelet #17638

memo of Ouranos Ecosystem IDI and data-transaction-system

2024-10-26

Data SpacesOuranos Ecosystem

Data Spaces, Ouranos Ecosystem

メモ

ouranos-ecosystem-idi / data-transaction-system に Ouranos Ecosystem のオープンソースソフトウェアが公開されている。

このOSSの主旨は、READMEにある通り、

本リポジトリ（Minimum Ouranos data platform）は企業・業界・国境を跨いだデータ連携・利活用を目指すイニシアティブの「ウラノス・エコシステム（Ouranos Ecosystem）」におけるデータ流通システムの最小実装を体験するため、実装の一部をオープンソースとして公開する。

である。

基本的にはREADMEに書かれている通りなので、特別に補足することはないが、なんとなくメモしておく。

README 実行環境に実行環境の情報が記載されている。記載の通り、基本的にはGo言語を用いて実装されている。

なお、以降以下のディレクトリ内に、各種レポジトリをクローンして用いる。

1
2
3

mkdir -p ~/Sources/ouranos-ecosystem-idi
cd ~/Sources/ouranos-ecosystem-idi
export OE_WORKDIR=~/Sources/ouranos-ecosystem-idi

なお、暫定的にワーキングディレクトリを示す便宜的な環境変数を作成しておいた。

認証データの構成

ユーザ認証システムにレポジトリがあるのでクローンして、認証システムを立ち上げる。

1
2
3

git clone git@github.com:ouranos-ecosystem-idi/user-authentication-system.git
cd ${OE_WORKDIR}/user-authentication-system/
docker compose up -d

docker-compose.ymlの通り、実態はDBMS（postgres）と簡易認証用のfirebaseである。 firebaseではエミュレータを用いる。

エミュレータコンフィグ配下の通り。

{
  "emulators": {
    "auth": {
      "host": "0.0.0.0",
      "port": 9099
    },
    "ui": {
      "enabled": true,
      "host": "0.0.0.0",
      "port": 4000
    },
    "singleProjectMode": true
  }
}

データベースのスキーマ定義。

1
2
3

cd ${OE_WORKDIR}/user-authentication-system/
export POSTGRESQL_URL='postgres://dhuser:passw0rd@localhost:5432/dhlocal?sslmode=disable'
migrate -path setup/migrations -database ${POSTGRESQL_URL} up

ダミーデータをDBに入力。

1 2	docker cp setup postgres:/setup docker exec -it postgres bash /setup/setup_seeds.sh

シェルスクリプトは、setup/seeders に含まれているSQLを実行するというもの。

setup/seeders
setup/seeders/000001_seed_api_keys.sql
setup/seeders/000002_seed_operators.sql
setup/seeders/000003_seed_apikey_operators.sql
setup/seeders/000004_cidrs.sql

上記の通り、APIキー、オペレータのIDなどを入力している。2件ずつ。

確認。

1	docker exec -i postgres bash -c "PGPASSWORD=passw0rd psql -h 127.0.0.1 -p 5432 -U dhuser dhlocal -c 'select * from operators'"

             operator_id              | operator_name | deleted_at |     created_at      | created_user_id |     updated_at      | updated_user_id | operator_address | open_operator_id |  global_operator_id  
--------------------------------------+---------------+------------+---------------------+-----------------+---------------------+-----------------+------------------+------------------+----------------------
 b39e6248-c888-56ca-d9d0-89de1b1adc8e | A社           |            | 2024-03-26 12:00:00 | seed            | 2024-03-26 12:00:00 | seed            | 東京都渋谷区xx   | 1234567890123    | 1234ABCD5678EFGH0123
 15572d1c-ec13-0d78-7f92-dd4278871373 | B社           |            | 2024-03-26 12:00:00 | seed            | 2024-03-26 12:00:00 | seed            | 東京都渋谷区xx   | 1234567890124    | 1234ABCD5678EFGH0124
(2 rows)

エミュレータに事業者情報を追加。

1	make idp-add-local

1
2
3

go run cmd/add_local_user/main.go
Successfully created user with email: oem_a@example.com and set custom claims. Password: oemA&user_01
Successfully created user with email: supplier_b@example.com and set custom claims. Password: supplierB&user_01

Makefileの中身は以下の通り。

Makefile:78

1 2	idp-add-local: go run cmd/add_local_user/main.go

このプログラムは、シード用CSVから事業者情報を登録する。

cmd/add_local_user/main.go:46

func addOperatorFromCSV(ctx context.Context, app *firebase.App, csvPath string) {

(snip)

	// create user by each record
	for _, record := range records {
		email := record[0]
		password := record[1]
		operatorID := record[2]
		operator := Operator{operatorID, email, password}
		addOperator(ctx, authClient, operator)
	}

cmd/add_local_user/main.go:76

func addOperator(ctx context.Context, authClient *auth.Client, operator Operator) {

(snip)

	err = authClient.SetCustomUserClaims(ctx, userRecord.UID, customClaims)

上記の通り、firebaseのauth.Clientを用いて登録している。

シードは、 cmd/add_local_user/data/seed.csv である。

1 2	oem_a@example.com,oemA&user_01,b39e6248-c888-56ca-d9d0-89de1b1adc8e supplier_b@example.com,supplierB&user_01,15572d1c-ec13-0d78-7f92-dd4278871373

OperatorのIDは、先程DBとに登録したものと同じ。

データ流通システムの起動

ビルド

1
2
3

cd ${OE_WORKDIR}/data-transaction-system
go build main.go
docker build -t data-spaces-backend .

起動

1	docker run -v $(pwd)/config/:/app/config/ -td -i --network docker.internal --env-file config/local.env -p 8080:8080 --name data-spaces-backend data-spaces-backend

（このあたりはcomposeになっていない…と）

ユーザ認証システムの起動

ビルド

1
2
3

cd ${OE_WORKDIR}/user-authentication-system/
go build main.go
docker build -t authenticator-backend .

起動

1	docker run -v $(pwd)/config/:/app/config/ -td -i --network docker.internal --env-file config/local.env -p 8081:8081 --name authenticator-backend authenticator-backend

これで一通り起動したはず。

docker ps

CONTAINER ID   IMAGE                                  COMMAND                   CREATED          STATUS                  PORTS                                                                                  NAMES
aa12c592f114   authenticator-backend                  "/app/server"             33 seconds ago   Up 33 seconds           0.0.0.0:8081->8081/tcp, :::8081->8081/tcp                                              authenticator-backend
46c1d0f82cf7   data-spaces-backend                    "/app/server"             3 minutes ago    Up 3 minutes            0.0.0.0:8080->8080/tcp, :::8080->8080/tcp                                              data-spaces-backend
7ccba96acee9   postgres:14                            "docker-entrypoint.s…"   2 hours ago      Up 2 hours              0.0.0.0:5432->5432/tcp, :::5432->5432/tcp                                              postgres
9e5bc7cf81ed   user-authentication-system-firebase    "docker-entrypoint.s…"   2 hours ago      Up 2 hours              0.0.0.0:4000->4000/tcp, :::4000->4000/tcp, 0.0.0.0:9099->9099/tcp, :::9099->9099/tcp   user-authentication-system-firebase-1

A社の事業者認証

事業者認証の通り、

A社がユーザ認証システムで事業者認証をした後に、自身の事業者情報を取得する例を示します。

認証情報取得

前提：

PF認定を受けた事業者に発行されるAPIキーを指定しAPIを利用する
事業者はAcountIdとPasswordを事前に払い出されている

認証情報を取得

curl -s --location --request POST 'http://localhost:8081/auth/login' --header 'Content-Type: application/json' --header 'apiKey: Sample-APIKey1' --data-raw '{
  "operatorAccountId": "oem_a@example.com",
  "accountPassword": "oemA&user_01"
}' | jq

{
  "accessToken": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.",
  "refreshToken": "eyJfQXV0aEVtdWxhdG9yUmVmcmVzaFRva2VuIjoiRE8gTk9UIE1PRElGWSIsImxvY2FsSWQiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDciLCJwcm92aWRlciI6InBhc3N3b3JkIiwiZXh0cmFDbGFpbXMiOnt9LCJwcm9qZWN0SWQiOiJsb2NhbCJ9"
}

事業者情報取得

先程取得したアクセストークンを使い、事業者情報を取得してみる。先の例と同様、APIキーも用いる。

curl -s --location --request GET 'http://localhost:8081/api/v1/authInfo?dataTarget=operator' \
--header 'apiKey: Sample-APIKey1' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
| jq

{
  "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
  "operatorName": "A社",
  "operatorAddress": "東京都渋谷区xx",
  "openOperatorId": "1234567890123",
  "operatorAttribute": {
    "globalOperatorId": "1234ABCD5678EFGH0123"
  }
}

A社の部品登録およびB社への回答依頼

部品登録にある通り。事業所登録、親部品情報の作成、部品構成情報の登録、CFP結果提出の依頼（A社=下流・OEMからB社=上流・サプライヤへの依頼）の順番で進める。

事業所登録

この時点では、事「業」所が登録されていないので登録する。 operatorId は先程取得した事業者情報の値を用いる。openPlantId、plantAddress、plantNaeは任意の値。 plantIdはNullで渡す。

curl -s --location --request PUT 'http://localhost:8081/api/v1/authInfo?dataTarget=plant' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
--data '{
  "openPlantId": "1234567890123012345",
  "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
  "plantAddress": "xx県xx市xxxx町1-1-1234",
  "plantId": null,
  "plantName": "A工場",
  "plantAttribute": {}
}' \
| jq

{
  "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
  "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
  "plantName": "A工場",
  "plantAddress": "xx県xx市xxxx町1-1-1234",
  "openPlantId": "1234567890123012345",
  "plantAttribute": {
    "globalPlantId": null
  }
}

結果中の、plantIdが埋まっていることがわかる。

また、APIが/v1/authInfoであることも注意。

親部品情報の作成

事業所を登録できたので、その情報を使って親部品情報を登録する。 plantIdは先程の戻り値に含まれていたものを利用。 traceIdはNullで渡す。

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=parts' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
--data '{
  "amountRequired": null,
  "amountRequiredUnit": "kilogram",
  "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
  "partsName": "部品A",
  "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
  "supportPartsName": "modelA",
  "terminatedFlag": false,
  "traceId": null
}' \
| jq

{
  "traceId": "675b19a3-380e-45d6-921f-38aad289e0d5",
  "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
  "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
  "partsName": "部品A",
  "supportPartsName": "modelA",
  "terminatedFlag": false,
  "amountRequired": null,
  "amountRequiredUnit": "kilogram"
}

traceIdが含まれた値が返ってきた。

部品構成情報の登録

親部品の登録が終わり、親部品のtraceIdも払い出されたので、その情報を使って、子部品を登録する。この時点で子部品のtraceIdはNullだが、戻り値に含まれていることがわかる。

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=partsStructure' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
--data '{
  "parentPartsModel": {
    "amountRequired": null,
    "amountRequiredUnit": "kilogram",
    "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
    "partsName": "部品A",
    "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
    "supportPartsName": "modelA",
    "terminatedFlag": false,
    "traceId": "8fc6aa29-5f4f-476e-85e3-2d1b54715891"
  },
  "childrenPartsModel": [
    {
      "amountRequired": 5,
      "amountRequiredUnit": "kilogram",
      "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
      "partsName": "部品A1",
      "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
      "supportPartsName": "modelA-1",
      "terminatedFlag": false,
      "traceId": null
    }
  ]
}' \
| jq

{
  "parentPartsModel": {
    "traceId": "8fc6aa29-5f4f-476e-85e3-2d1b54715891",
    "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
    "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
    "partsName": "部品A",
    "supportPartsName": "modelA",
    "terminatedFlag": false,
    "amountRequired": null,
    "amountRequiredUnit": "kilogram"
  },
  "childrenPartsModel": [
    {
      "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
      "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
      "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
      "partsName": "部品A1",
      "supportPartsName": "modelA-1",
      "terminatedFlag": false,
      "amountRequired": 5,
      "amountRequiredUnit": "kilogram"
    }
  ]
}

CFP結果提出の依頼（AからBに）

/v1/authInfo APIを用いて、まずはB社の事業者識別子（内部）を取得する。 openOperatorId （事業者識別子（公開））は事前に知っているものとする。

curl -s --location --request GET 'http://localhost:8081/api/v1/authInfo?dataTarget=operator&openOperatorId=1234567890124' \
--header 'apiKey: Sample-APIKey1' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
| jq

{
  "operatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
  "operatorName": "B社",
  "operatorAddress": "東京都渋谷区xx",
  "openOperatorId": "1234567890124",
  "operatorAttribute": {
    "globalOperatorId": "1234ABCD5678EFGH0124"
  }
}

続いて、A社からB社に対しての取引関係を作成し、紐付け回答依頼を行う。 downstreamTraceIdには先に取得しておいた、下流（つまり、A社 = OEM側）のもつtraceIdを指定する。先ほど作った親子関係のうち、子部品（つまり、上流由来の部品）のIDを指定する。

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=tradeRequest' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzMzQ1OSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzM0NTksImV4cCI6MTczMDAzNzA1OSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
--data '{
  "statusModel": {
    "message": "来月中にご回答をお願いします。",
    "replyMessage": null,
    "requestStatus": {},
    "requestType": "CFP",
    "statusId": null,
    "tradeId": null
  },
  "tradeModel": {
    "downstreamOperatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
    "downstreamTraceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "tradeId": null,
    "upstreamOperatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
    "upstreamTraceId": null
  }
}' \
| jq

{
  "tradeModel": {
    "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
    "downstreamOperatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
    "upstreamOperatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
    "downstreamTraceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "upstreamTraceId": null
  },
  "statusModel": {
    "statusId": "a6e4a7f2-bb5c-4414-8026-75a46ea4436d",
    "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
    "requestStatus": {
      "cfpResponseStatus": "NOT_COMPLETED",
      "tradeTreeStatus": "UNTERMINATED"
    },
    "message": "来月中にご回答をお願いします。",
    "replyMessage": null,
    "requestType": "CFP"
  }
}

リクエスト時はNullだった、statusId、tradeIdが返ってきていることがわかる。（traceIdとtradeIdが紛らわしいので注意）

B社の部品登録紐付け

部品登録紐付けの通り。おおむね、B社の事業者認証（アクセストークン取得）、B社の事業所情報の登録、B社親部品登録、紐付け以来の確認、部品登録紐付けの登録、の流れ。

事業社認証

A社のときと同じく、B社においても認証情報を取得する。

curl -s --location --request POST 'http://localhost:8081/auth/login' \
--header 'Content-Type: application/json' \
--header 'apiKey: Sample-APIKey1' \
--data-raw '{
  "operatorAccountId": "supplier_b@example.com",
  "accountPassword": "supplierB&user_01"
}' \
| jq

{
  "accessToken": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6IjE1NTcyZDFjLWVjMTMtMGQ3OC03ZjkyLWRkNDI3ODg3MTM3MyIsImVtYWlsIjoic3VwcGxpZXJfYkBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiYXV0aF90aW1lIjoxNzMwMDM1ODMwLCJ1c2VyX2lkIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3IiwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJzdXBwbGllcl9iQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifSwiaWF0IjoxNzMwMDM1ODMwLCJleHAiOjE3MzAwMzk0MzAsImF1ZCI6ImxvY2FsIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2xvY2FsIiwic3ViIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3In0.",
  "refreshToken": "eyJfQXV0aEVtdWxhdG9yUmVmcmVzaFRva2VuIjoiRE8gTk9UIE1PRElGWSIsImxvY2FsSWQiOiJjN2FlOGYzZS1jZDhjLTRkOTUtOGE2NC02ZjRjYjJlZGQxYTciLCJwcm92aWRlciI6InBhc3N3b3JkIiwiZXh0cmFDbGFpbXMiOnt9LCJwcm9qZWN0SWQiOiJsb2NhbCJ9"
}

事業所の登録

A社のときと同じく、B社においても事業「所」情報を登録する。

curl -s --location --request PUT 'http://localhost:8081/api/v1/authInfo?dataTarget=plant' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6IjE1NTcyZDFjLWVjMTMtMGQ3OC03ZjkyLWRkNDI3ODg3MTM3MyIsImVtYWlsIjoic3VwcGxpZXJfYkBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiYXV0aF90aW1lIjoxNzMwMDM1ODMwLCJ1c2VyX2lkIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3IiwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJzdXBwbGllcl9iQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifSwiaWF0IjoxNzMwMDM1ODMwLCJleHAiOjE3MzAwMzk0MzAsImF1ZCI6ImxvY2FsIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2xvY2FsIiwic3ViIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3In0.' \
--data '{
  "openPlantId": "1234567890124012345",
  "operatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
  "plantAddress": "xx県xx市xxxx町2-1-1234",
  "plantId": null,
  "plantName": "B工場",
  "plantAttribute": {}
}' \
| jq

{
  "plantId": "2dbe5ede-0140-4a47-8bf7-3ab3947866c7",
  "operatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
  "plantName": "B工場",
  "plantAddress": "xx県xx市xxxx町2-1-1234",
  "openPlantId": "1234567890124012345",
  "plantAttribute": {
    "globalPlantId": null
  }
}

リクエストのときはNullだった、plantIdが返っていることがわかる。

親部品情報の作成

A社のときと同じく、親部品情報を作成する。認証トークンとplantIdは先程取得したものを用いること。

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=parts' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6IjE1NTcyZDFjLWVjMTMtMGQ3OC03ZjkyLWRkNDI3ODg3MTM3MyIsImVtYWlsIjoic3VwcGxpZXJfYkBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiYXV0aF90aW1lIjoxNzMwMDM1ODMwLCJ1c2VyX2lkIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3IiwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJzdXBwbGllcl9iQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifSwiaWF0IjoxNzMwMDM1ODMwLCJleHAiOjE3MzAwMzk0MzAsImF1ZCI6ImxvY2FsIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2xvY2FsIiwic3ViIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3In0.' \
--data '{
  "amountRequired": null,
  "amountRequiredUnit": "kilogram",
  "operatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
  "partsName": "部品B",
  "plantId": "2dbe5ede-0140-4a47-8bf7-3ab3947866c7",
  "supportPartsName": "modelB",
  "terminatedFlag": true,
  "traceId": null
}' \
| jq

{
  "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
  "operatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
  "plantId": "2dbe5ede-0140-4a47-8bf7-3ab3947866c7",
  "partsName": "部品B",
  "supportPartsName": "modelB",
  "terminatedFlag": true,
  "amountRequired": null,
  "amountRequiredUnit": "kilogram"
}

リクエスト時はNullだったtraceIdが返っていることがわかる。

紐付け依頼確認

今回は、予めA社（OEM、下流）から回答依頼を送っているのだが、改めてB社（サプライヤ、上流）側で依頼を確認する。

curl -s --location --request GET 'http://localhost:8080/api/v1/datatransport?dataTarget=tradeResponse' \
--header 'apiKey: Sample-APIKey1' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6IjE1NTcyZDFjLWVjMTMtMGQ3OC03ZjkyLWRkNDI3ODg3MTM3MyIsImVtYWlsIjoic3VwcGxpZXJfYkBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiYXV0aF90aW1lIjoxNzMwMDM1ODMwLCJ1c2VyX2lkIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3IiwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJzdXBwbGllcl9iQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifSwiaWF0IjoxNzMwMDM1ODMwLCJleHAiOjE3MzAwMzk0MzAsImF1ZCI6ImxvY2FsIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2xvY2FsIiwic3ViIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3In0.' \
| jq

[
 {
    "statusModel": {
      "statusId": "a6e4a7f2-bb5c-4414-8026-75a46ea4436d",
      "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
      "requestStatus": {
        "cfpResponseStatus": "NOT_COMPLETED",
        "tradeTreeStatus": "UNTERMINATED"
      },
      "message": "来月中にご回答をお願いします。",
      "replyMessage": null,
      "requestType": "CFP"
    },
    "tradeModel": {
      "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
      "downstreamOperatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
      "upstreamOperatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
      "downstreamTraceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
      "upstreamTraceId": null
    },
    "partsModel": {
      "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
      "operatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
      "plantId": "4c110e31-46a3-48d9-89d3-afdefcfcb7dc",
      "partsName": "部品A",
      "supportPartsName": "modelA",
      "terminatedFlag": false,
      "amountRequired": null,
      "amountRequiredUnit": "kilogram"
    }
  }
]

statusIdやtradeIdが先程A社側で見たものと同じであることがわかる。

部品登録紐付けの登録

依頼に回答する。APIのパラメータtradeIdとtraceIdには、先程取得した依頼回答にあった値を用いる。つまり、traddeIdは依頼回答一覧似合ったものを用いる。traceIdには、先程B社側で作成した親部品情報を用いる。（A社側の値ではないことに注意）

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=tradeResponse&tradeId=aeb60293-2477-4f58-94ac-8b24cb32103f&traceId=28410c0f-1796-4d1b-b30b-db4aa4b8d28f' \
--header 'apiKey: Sample-APIKey1' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6IjE1NTcyZDFjLWVjMTMtMGQ3OC03ZjkyLWRkNDI3ODg3MTM3MyIsImVtYWlsIjoic3VwcGxpZXJfYkBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiYXV0aF90aW1lIjoxNzMwMDM1ODMwLCJ1c2VyX2lkIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3IiwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJzdXBwbGllcl9iQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifSwiaWF0IjoxNzMwMDM1ODMwLCJleHAiOjE3MzAwMzk0MzAsImF1ZCI6ImxvY2FsIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2xvY2FsIiwic3ViIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3In0.' \
| jq

{
  "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
  "downstreamOperatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
  "upstreamOperatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
  "downstreamTraceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
  "upstreamTraceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f"
}

以上で、A社とB社の間で異なる部品情報を持ったまま、それらをつなぐ関係情報が作成された。

B社のCFP情報の伝達

CFP情報伝達の通り。B社が登録する。手順書に記載があるが、ここで登録するCFP値は、アプリケーション側で自社の利用する算出されたものを登録する、という前提になっている。

traceIdには、先程作成したB社側の親部品情報の値を用いる。

なお、本来の実装では、この作業を実施後に、A社に対してCFP情報、DQR情報を開示する手順があるのだが、本記事で紹介している手順では自動で許可されるようになっている。

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=cfp' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6IjE1NTcyZDFjLWVjMTMtMGQ3OC03ZjkyLWRkNDI3ODg3MTM3MyIsImVtYWlsIjoic3VwcGxpZXJfYkBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiYXV0aF90aW1lIjoxNzMwMDM1ODMwLCJ1c2VyX2lkIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3IiwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJzdXBwbGllcl9iQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifSwiaWF0IjoxNzMwMDM1ODMwLCJleHAiOjE3MzAwMzk0MzAsImF1ZCI6ImxvY2FsIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2xvY2FsIiwic3ViIjoiYzdhZThmM2UtY2Q4Yy00ZDk1LThhNjQtNmY0Y2IyZWRkMWE3In0.' \
--data '[
  {
    "cfpId": null,
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 1.5,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "preProduction",
    "dqrType": "preProcessing",
    "dqrValue": {
      "TeR": 1,
      "GeR": 2,
      "TiR": 3
    }
  },
  {
    "cfpId": null,
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 10.0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "mainProduction",
    "dqrType": "mainProcessing",
    "dqrValue": {
      "TeR": 2,
      "GeR": 3,
      "TiR": 4
    }
  },
  {
    "cfpId": null,
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "preComponent",
    "dqrType": "preProcessing",
    "dqrValue": {
      "TeR": 1,
      "GeR": 2,
      "TiR": 3
    }
  },
  {
    "cfpId": null,
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "mainComponent",
    "dqrType": "mainProcessing",
    "dqrValue": {
      "TeR": 2,
      "GeR": 3,
      "TiR": 4
    }
  }
]' \
| jq

[
  {
    "cfpId": "2b289894-846f-4563-916f-0c238aa5216f",
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 1.5,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "preProduction",
    "dqrType": "preProcessing",
    "dqrValue": {
      "TeR": 1,
      "GeR": 2,
      "TiR": 3
    }
  },
  {
    "cfpId": "2b289894-846f-4563-916f-0c238aa5216f",
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 10,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "mainProduction",
    "dqrType": "mainProcessing",
    "dqrValue": {
      "TeR": 2,
      "GeR": 3,
      "TiR": 4
    }
  },
  {
    "cfpId": "2b289894-846f-4563-916f-0c238aa5216f",
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "preComponent",
    "dqrType": "preProcessing",
    "dqrValue": {
      "TeR": 1,
      "GeR": 2,
      "TiR": 3
    }
  },
  {
    "cfpId": "2b289894-846f-4563-916f-0c238aa5216f",
    "traceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f",
    "ghgEmission": 0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "mainComponent",
    "dqrType": "mainProcessing",
    "dqrValue": {
      "TeR": 2,
      "GeR": 3,
      "TiR": 4
    }
  }
]

A社における回答取得

回答取得の通り。 A社側で、B社の回答を取得する。

回答依頼情報の取得

タイムアウトしてトークンが無効になっているかもしれないので、認証情報を取得

curl -s --location --request POST 'http://localhost:8081/auth/login' --header 'Content-Type: application/json' --header 'apiKey: Sample-APIKey1' --data-raw '{
  "operatorAccountId": "oem_a@example.com",
  "accountPassword": "oemA&user_01"
}' | jq

{
  "accessToken": "eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzODQ1NSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzg0NTUsImV4cCI6MTczMDA0MjA1NSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.",
  "refreshToken": "eyJfQXV0aEVtdWxhdG9yUmVmcmVzaFRva2VuIjoiRE8gTk9UIE1PRElGWSIsImxvY2FsSWQiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDciLCJwcm92aWRlciI6InBhc3N3b3JkIiwiZXh0cmFDbGFpbXMiOnt9LCJwcm9qZWN0SWQiOiJsb2NhbCJ9"
}

取得したアクセストークンを使いつつ、回答情報を取得。

curl -s --location --request GET 'http://localhost:8080/api/v1/datatransport?dataTarget=tradeRequest' \
--header 'apiKey: Sample-APIKey1' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzODQ1NSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzg0NTUsImV4cCI6MTczMDA0MjA1NSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
| jq

[
  {
    "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
    "downstreamOperatorId": "b39e6248-c888-56ca-d9d0-89de1b1adc8e",
    "upstreamOperatorId": "15572d1c-ec13-0d78-7f92-dd4278871373",
    "downstreamTraceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "upstreamTraceId": "28410c0f-1796-4d1b-b30b-db4aa4b8d28f"
  }
]

依頼情報のステータス確認

statusTarget=REQUEST ... A社が依頼元のステータスのみ取得
traceId ... A社がB社に依頼している自社のtraceId（子部品のID）を指定する。

curl -s --location --request GET 'http://localhost:8080/api/v1/datatransport?dataTarget=status&statusTarget=REQUEST&traceId=c6e15178-90ed-4605-ad69-2abebae7d18a' \
--header 'apiKey: Sample-APIKey1' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzODQ1NSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzg0NTUsImV4cCI6MTczMDA0MjA1NSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
| jq

[
  {
    "statusId": "a6e4a7f2-bb5c-4414-8026-75a46ea4436d",
    "tradeId": "aeb60293-2477-4f58-94ac-8b24cb32103f",
    "requestStatus": {
      "cfpResponseStatus": "COMPLETED",
      "tradeTreeStatus": "TERMINATED"
    },
    "message": "来月中にご回答をお願いします。",
    "replyMessage": null,
    "requestType": "CFP"
  }
]

A社において完成品のCFP値を算出する

完成品CFP値の通り。本来は、アプリケーションにてCFPを計算する。 traceIdには、A社側の子部品のtraceIdを指定する。

curl -s --location --request PUT 'http://localhost:8080/api/v1/datatransport?dataTarget=cfp' \
--header 'apiKey: Sample-APIKey1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJvcGVyYXRvcl9pZCI6ImIzOWU2MjQ4LWM4ODgtNTZjYS1kOWQwLTg5ZGUxYjFhZGM4ZSIsImVtYWlsIjoib2VtX2FAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImF1dGhfdGltZSI6MTczMDAzODQ1NSwidXNlcl9pZCI6IjhmMDVmZWY1LWE3ZGEtNGVjMS1iY2FjLTMyNTIwMzM0ODVkNyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsib2VtX2FAZXhhbXBsZS5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9LCJpYXQiOjE3MzAwMzg0NTUsImV4cCI6MTczMDA0MjA1NSwiYXVkIjoibG9jYWwiLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vbG9jYWwiLCJzdWIiOiI4ZjA1ZmVmNS1hN2RhLTRlYzEtYmNhYy0zMjUyMDMzNDg1ZDcifQ.' \
--data '[
    {
        "cfpId": null,
        "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
        "ghgEmission": 3.0,
        "ghgDeclaredUnit": "kgCO2e/kilogram",
        "cfpType": "preProduction",
        "dqrType": "preProcessing",
        "dqrValue": {
            "TeR": 1,
            "GeR": 2,
            "TiR": 3
        }
    },
    {
        "cfpId": null,
        "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
        "ghgEmission": 20.0,
        "ghgDeclaredUnit": "kgCO2e/kilogram",
        "cfpType": "mainProduction",
        "dqrType": "mainProcessing",
        "dqrValue": {
            "TeR": 2,
            "GeR": 3,
            "TiR": 4
        }
    },
    {
        "cfpId": null,
        "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
        "ghgEmission": 0,
        "ghgDeclaredUnit": "kgCO2e/kilogram",
        "cfpType": "preComponent",
        "dqrType": "preProcessing",
        "dqrValue": {
            "TeR": 1,
            "GeR": 2,
            "TiR": 3
        }
    },
    {
        "cfpId": null,
        "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
        "ghgEmission": 0,
        "ghgDeclaredUnit": "kgCO2e/kilogram",
        "cfpType": "mainComponent",
        "dqrType": "mainProcessing",
        "dqrValue": {
            "TeR": 2,
            "GeR": 3,
            "TiR": 4
        }
    }
]' \
| jq

[
  {
    "cfpId": "b626d92e-e6e3-4769-98d1-1ff8b6714230",
    "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "ghgEmission": 3,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "preProduction",
    "dqrType": "preProcessing",
    "dqrValue": {
      "TeR": 1,
      "GeR": 2,
      "TiR": 3
    }
  },
  {
    "cfpId": "b626d92e-e6e3-4769-98d1-1ff8b6714230",
    "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "ghgEmission": 20,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "mainProduction",
    "dqrType": "mainProcessing",
    "dqrValue": {
      "TeR": 2,
      "GeR": 3,
      "TiR": 4
    }
  },
  {
    "cfpId": "b626d92e-e6e3-4769-98d1-1ff8b6714230",
    "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "ghgEmission": 0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "preComponent",
    "dqrType": "preProcessing",
    "dqrValue": {
      "TeR": 1,
      "GeR": 2,
      "TiR": 3
    }
  },
  {
    "cfpId": "b626d92e-e6e3-4769-98d1-1ff8b6714230",
    "traceId": "c6e15178-90ed-4605-ad69-2abebae7d18a",
    "ghgEmission": 0,
    "ghgDeclaredUnit": "kgCO2e/kilogram",
    "cfpType": "mainComponent",
    "dqrType": "mainProcessing",
    "dqrValue": {
      "TeR": 2,
      "GeR": 3,
      "TiR": 4
    }
  }
]

(wip)

データ流通システムの様子

データ流通システムの main.go を見ると概要がわかる。

このアプリケーションは、Echoを使って作られている。

Routerの様子

APIは単純で、/api/v1/datatransportのGETとPUTのみ。

presentation/http/echo/router/router.go:39

1 2	e.GET("/api/v1/datatransport", func(c echo.Context) error { return h.GetOuranos(c) }) e.PUT("/api/v1/datatransport", func(c echo.Context) error { return h.PutOuranos(c) })

部品情報登録のハンドラー

hはhandler.AppHandlerなのだが、以下の通り。

// appHandler
// Summary: This is structure which defines appHandler.
type appHandler struct {
	handler.AuthHandler
	handler.OuranosHandler
}

AuthHandlerは名前の通り、認証関連。APIキーやトークンの処理。

presentation/http/echo/handler/auth_handler.go:10

AuthHandler interface {
	VerifyAPIKey(c echo.Context) error
	VerifyToken(c echo.Context) (*string, error)
}

OuranosHandlerがデータのやり取りのためのハンドラーであり、GET/PUTを扱う。ハンドラーの定義は以下の通り。

presentation/http/echo/handler/ouranos_handler.go:5

type (
	OuranosHandler interface {
		GetOuranos(c echo.Context) error
		PutOuranos(c echo.Context) error
	}

	ouranosHandler struct {
		cfpHandler              ICfpHandler
		cfpCertificationHandler ICfpCertificationHandler
		partsHandler            IPartsHandler
		partsStructureHandler   IPartsStructureHandler
		tradeHandler            ITradeHandler
		statusHandler           IStatusHandler
	}
)

PutOuranosを見てみる。

presentation/http/echo/handler/ouranos_put.go:15

func (h *ouranosHandler) PutOuranos(c echo.Context) error {
	method := c.Request().Method
	operatorID := c.Get("operatorID").(string)

	dataTarget := c.QueryParam("dataTarget")

	switch dataTarget {
	case "partsStructure":
		return h.partsStructureHandler.PutPartsStructureModel(c)
	case "parts":
		return h.partsHandler.PutPartsModel(c)
	case "tradeRequest":
		return h.tradeHandler.PutTradeRequest(c)
	case "tradeResponse":
		return h.tradeHandler.PutTradeResponse(c)
	case "cfp":
		return h.cfpHandler.PutCfp(c)
	case "status":
		return h.statusHandler.PutStatus(c)
	default:
		errDetails := common.UnexpectedQueryParameter("dataTarget")
		return echo.NewHTTPError(common.HTTPErrorGenerate(http.StatusBadRequest, common.HTTPErrorSourceDataspace, common.Err400InvalidRequest, operatorID, dataTarget, method, errDetails))
	}
}

dataTargetの中身によって処理を変える。例えば、親部品作成時には、partsが呼ばれていた。インターフェース定義は以下。

presentation/http/echo/handler/ouranos_traceability_parts.go:18

type IPartsHandler interface {
	// GetPartsModel
	// Summary: This is function which defines #8 GetPartsList.
	GetPartsModel(c echo.Context) error
	// PutPartsModel
	// Summary: This is function which defines #5 PutPartsItem.
	PutPartsModel(c echo.Context) error
}

PutPartsModelの実装が以下。

presentation/http/echo/handler/ouranos_traceability_parts.go:144

func (h *partsHandler) PutPartsModel(c echo.Context) error {

	dataTarget := c.QueryParam("dataTarget")
	method := c.Request().Method

	operatorID := c.Get("operatorID").(string)

(snip)

最初にoperatorIDを取得している。

続いて入力を取得。

presentation/http/echo/handler/ouranos_traceability_parts.go:151

if err := c.Bind(&putPartsInput); err != nil {
	logger.Set(c).Warnf(err.Error())
	errDetails := common.FormatBindErrMsg(err)

	return echo.NewHTTPError(common.HTTPErrorGenerate(http.StatusBadRequest, common.HTTPErrorSourceDataspace, common.Err400Validation, operatorID, dataTarget, method, errDetails))
}
fmt.Printf("PutPartsInput: %+v\n", putPartsInput)

domain/model/traceability/ouranos_parts_model.go:138

type PutPartsInput struct {
	OperatorID         string   `json:"operatorId"`
	TraceID            *string  `json:"traceId"`
	PlantID            string   `json:"plantId"`
	PartsName          string   `json:"partsName"`
	SupportPartsName   *string  `json:"supportPartsName"`
	TerminatedFlag     *bool    `json:"terminatedFlag"`
	AmountRequired     *float64 `json:"amountRequired"`
	AmountRequiredUnit *string  `json:"amountRequiredUnit"`
}

バリデーション。

presentation/http/echo/handler/ouranos_traceability_parts.go:159

if err := putPartsInput.Validate(); err != nil {
	logger.Set(c).Warnf(err.Error())
	errDetails := err.Error()

	return echo.NewHTTPError(common.HTTPErrorGenerate(http.StatusBadRequest, common.HTTPErrorSourceDataspace, common.Err400Validation, operatorID, dataTarget, method, errDetails))
}
if operatorID != putPartsInput.OperatorID {
	logger.Set(c).Warnf(common.Err403AccessDenied)

	return echo.NewHTTPError(common.HTTPErrorGenerate(http.StatusForbidden, common.HTTPErrorSourceDataspace, common.Err403AccessDenied, operatorID, dataTarget, method))
}

パーツのモデルを作成。

partsModel, err := putPartsInput.ToModel()
if err != nil {
	logger.Set(c).Warnf(err.Error())
	errDetails := err.Error()

	return echo.NewHTTPError(common.HTTPErrorGenerate(http.StatusBadRequest, common.HTTPErrorSourceDataspace, common.Err400Validation, operatorID, dataTarget, method, errDetails))
}
var partsStructureModel = traceability.PartsStructureModel{
	ParentPartsModel: &partsModel,
}
fmt.Printf("PutParts: PartsStructureModel: %+v\n", partsStructureModel)

パーツモデルをPut。

presentation/http/echo/handler/ouranos_traceability_parts.go:183

1	res, err := h.partsStructureUsecase.PutPartsStructure(c, partsStructureModel)

PUtPartsStructureの実装のひとつは以下。

usecase/parts_structure_usecase_datastore_impl.go:55

func (u *partsStructureUsecase) PutPartsStructure(c echo.Context, partsStructureModel traceability.PartsStructureModel) (traceability.PartsStructureModel, error) {

	partsStructure, err := u.OuranosRepository.PutPartsStructure(partsStructureModel)
	if err != nil {
		logger.Set(c).Errorf(err.Error())
		return traceability.PartsStructureModel{}, err
	}
	partsStructureModels, err := partsStructure.ToModel()
	if err != nil {
		logger.Set(c).Errorf(err.Error())

		return traceability.PartsStructureModel{}, err
	}
	return partsStructureModels, nil
}

もうひとつは、

usecase/parts_structure_usecase_traceability_impl.go:61

1
2
3

func (u *partsStructureTraceabilityUsecase) PutPartsStructure(c echo.Context, partsStructureModel traceability.PartsStructureModel) (traceability.PartsStructureModel, error) {

(snip)

参考

Echo

memo of CADDE

2024-10-21

Dataspace ConnectorCADDE

Connector, Data Space

メモ
参考

メモ

CADDE-sip/connector のREADMEを読んでメモする。

前提

CADDE-sip/connector/README 前提条件に色々書いてある。

1	カタログ検索、データ交換、認証、認可、来歴、契約の機能を具備します。

これらの機能を利用するためのAPIを具備している、くらいの読み方の方が良いかも。

導入ガイドライン

CADDE-sip/connector/README 導入ガイドラインにドキュメントの置き場所が書いてある。このあたりは、先に読んでおいたほうが良いだろう。

利用者コネクタ

CADDE-sip/connector/README 利用者コネクタの構築手順の通り、クローンしたレポジトリの src/consumer/ 内に利用者コネクタのソースコードがある。

アーキテクチャの概要は以下に載っている。

CADDE-sip/connector/README 利用者アーキテクチャ図

利用者目線でのざっくりとした理解

上記図の、コネクタメイン（利用者側）の左側に、カタログ検索I/Fとデータ取得I/Fがあるが、これが利用者絡みたときの接点となるI/Fである。

コネクタイメインのSwagger定義で言えば以下。src/consumer/connector-main/swagger_server/swagger/swagger.yaml

カタログ検索 paths./cadde/api/v4/catalog

  /cadde/api/v4/catalog:
    get:
      tags:
      - Search
      summary: API. カタログ検索
      description: |-
        カタログ情報を取得する。APIユーザが指定した条件に従いカタログ情報を取得する。

        Response:
        * 処理が成功した場合は200を返す。
        * 処理に失敗した場合は、2xx以外のコードを返す。 Responsesセクション参照。
      operationId: search

(snip)

データ取得 paths./cadde/api/v4/file

  /cadde/api/v4/file:
    get:
      tags:
      - Files
      summary: API. データ取得（CADDE）
      description: |-
        リソースURLに指定されたデータを取得する。

        Response:
        * 処理が成功した場合は200を返す。
        * 処理に失敗した場合は、2xx以外のコードを返す。 Responsesセクションを参照。
      operationId: files

(snip)

Swaggerの定義に基づき、PythonのFlask使って作られている。

ロケーション情報　

手順では src/consumer/connector-main/swagger_server/configs/location.json を編集することで、提供者コネクタのアドレス設定をするように書かれている。

このファイルは以下のような内容。

{
    "connector_location": {
        "test-provider:catalog": {
            "provider_connector_url": "http://10.0.4.71:28080"
        },
        "test-provider:data": {
            "provider_connector_url": "http://10.0.4.71:38080"
        }
    }
}

あるデータ提供者コネクタのカタログAPI、データAPI（？）のURLが記載されている。

このファイルがどこで利用されるかというと、サービス定義内の以下。

src/consumer/connector-main/swagger_server/services/service.py:384

1	def __get_location_info(provider, location_service_url, external_interface) -> (str):

ロケーションサービスから取得ができなかった場合、 location.jsonからコンフィグ情報を取得する。

とある通り、まずロケーションサービスから情報を取得するようにしレスポンスがあったらリターン。

src/consumer/connector-main/swagger_server/services/service.py:418

if response:
    if response.endswith('/'):
        response = response[:-1]
    provider_connector_url = response

    return provider_connector_url

だめな場合は、コンフィグから読み込む。

src/consumer/connector-main/swagger_server/services/service.py:425

# コンフィグから再取得を試みる
logger.info(f'Not Found {provider} from {location_service_url}')
try:
    config = internal_interface.config_read(__CONFIG_LOCATION_FILE_PATH)
except Exception:  # pathミス
    raise CaddeException(message_id='020000003E')

この __get_location_info 関数は2箇所で利用されている。

1
2
3

__get_location_info(provider, location_service_url, external_interface)
  catalog_search(query_string, search, provider, authorization, external_interface=ExternalInterface())
  fetch_data(authorization, resource_url, resource_api_type, provider, options, external_interface=ExternalInterface())

ひとつがカタログ検索内。

src/consumer/connector-main/swagger_server/services/service.py:42

def catalog_search(
        query_string: str,
        search: str,
        provider: str,
        authorization: str,
        external_interface: ExternalInterface = ExternalInterface()) -> Response:
    """
    カタログ検索I/Fに、カタログ検索を行い、検索結果を返す

    Args:
        query_string str : クエリストリング
        search str : 検索種別
        provider str: CADDEユーザID（提供者）
        authorization str: 利用者トークン
        external_interface ExternalInterface : GETリクエストを行うインタフェース

    Returns:
        Response : 取得した情報

    Raises:
        Cadde_excption: 検索種別確認時に不正な値が設定されている場合                エラーコード: 020001002E
        Cadde_excption: 認証I/F 認証トークン検証処理でエラーが発生した場合          エラーコード: 020001003E
        Cadde_excption: 提供者コネクタURLの取得に失敗した場合                       エラーコード: 020001004E
        Cadde_excption: カタログ検索I/Fのカタログ検索処理でエラーが発生した場合      エラーコード: 020001005E

    """
(snip)

カタログ検索機能を利用する際、もし詳細検索であれば、ロケーション情報を取得する。

src/consumer/connector-main/swagger_server/services/service.py:99

if search == 'detail':
    provider_connector_url = __get_location_info(
        provider, location_service_url, external_interface)
    if not provider_connector_url:
        raise CaddeException('020001004E')

もうひとつがデータの取得時。

src/consumer/connector-main/swagger_server/services/service.py:142

def fetch_data(authorization: str,
               resource_url: str,
               resource_api_type: str,
               provider: str,
               options: dict,
               external_interface: ExternalInterface = ExternalInterface()) -> (BytesIO,
                                                                                dict):
    """
    データ交換I/Fからデータを取得する、もしくはデータ管理から直接データを取得する。

    Args:
        resource_url str : リソースURL
        resource_api_type str : リソース提供手段識別子
        provider str : CADDEユーザID（提供者）
        authorization str : 利用者トークン
        options : dict リクエストヘッダ情報 key:ヘッダ名 value:パラメータ
        external_interface ExternalInterface : GETリクエストを行うインタフェース

    Returns:
        BytesIO :取得データ
        dict: レスポンスヘッダ情報 key:ヘッダ名 value:パラメータ レスポンスヘッダがない場合は空のdictを返す

(snip)

提供社のCADDEユーザIDが与えられたときにロケーション情報を取得する。

src/consumer/connector-main/swagger_server/services/service.py:230

    # CADDEユーザID（提供者）あり
    else:

        provider_connector_url = __get_location_info(
            provider, location_service_url, external_interface)
        if not provider_connector_url:
            raise CaddeException('020004003E')

(snip)

コネクタ設定

READMEの通り、コネクタのIDやシークレットキーの設定は src/consumer/connector-main/swagger_server/configs/connector.json にて行う。

以下のような内容。

{
    "consumer_connector_id" : "test_consumer_connector_id",
    "consumer_connector_secret" : "test_consumer_connector_secret",
    "location_service_url" : "https://testexample.com",
    "trace_log_enable" : true
}

また、これが用いられるのは、以下。

src/consumer/connector-main/swagger_server/services/service.py:486

def __get_connector_config() -> (str, str, str, str):
    """
    connector.jsonからコンフィグ情報を取得し、
    利用者側コネクタID、利用者側コネクタのシークレット、来歴管理者用トークンを返す。

    Returns:
        str: 利用者側コネクタID
        str: 利用者側コネクタのシークレット
        str: ロケーションサービスのURL
        str: トレースログ設定

    Raises:
        Cadde_excption: コンフィグファイルの読み込みに失敗した場合                                エラーコード: 020000005E
        Cadde_excption: 必須パラメータが設定されていなかった場合（利用者コネクタID）              エラーコード: 020000006E
        Cadde_excption: 必須パラメータが設定されていなかった場合（利用者コネクタのシークレット）  エラーコード: 020000007E
        Cadde_excption: 必須パラメータが設定されていなかった場合（ロケーションサービスのURL）     エラーコード: 020000008E
        Cadde_excption: 必須パラメータが設定されていなかった場合（トレースログ設定）              エラーコード: 020000009E

    """

(snip)

この関数が利用されるのは以下。

1
2
3

__get_connector_config()
  catalog_search(query_string, search, provider, authorization, external_interface=ExternalInterface())
  fetch_data(authorization, resource_url, resource_api_type, provider, options, external_interface=ExternalInterface())

両方とも同様の使われ方。基本的には、呼び出して必要な値を読み出す。以下は、カタログ検索での例。

src/consumer/connector-main/swagger_server/services/service.py:72

1	consumer_connector_id, consumer_connector_secret, location_service_url, trace_log_enable = __get_connector_config()

得られた値は、例えば認証トークン検証などに用いられる。

src/consumer/connector-main/swagger_server/services/service.py:76

    if authorization:
        # 認証トークン検証
        token_introspect_headers = {
            'Authorization': authorization,
            'x-cadde-consumer-connector-id': consumer_connector_id,
            'x-cadde-consumer-connector-secret': consumer_connector_secret
        }
        token_introspect_response = external_interface.http_get(
            __ACCESS_POINT_URL_AUTHENTICATION_AUTHORIZATION_INTROSPECT, token_introspect_headers)

        if token_introspect_response.status_code < 200 or 300 <= token_introspect_response.status_code:
            raise CaddeException(
                message_id='020001003E',
                status_code=token_introspect_response.status_code,
                replace_str_list=[
                    token_introspect_response.text])

        consumer_id = token_introspect_response.headers['x-cadde-consumer-id']

(snip)

その他

NGSIの設定や、横断検索用CKAN URLの設定の説明がある。

横断検索用CKAN URL設定の使われどころ。 src/consumer/catalog-search/swagger_server/services/service.py:13

def search_catalog_meta(
        q: str,
        internal_interface: InternalInterface,
        external_interface: ExternalInterface) -> Response:
    """
    横断検索を行い、横断検索サイトからカタログ情報を取得する

    Args:
        q str : 検索条件のクエリストリング
        internal_interface InternalInterface : コンフィグ情報取得処理を行うインタフェース
        external_interface ExternalInterface : GETリクエストを行うインタフェース

    Returns:
        Response : 取得した情報

    Raises:
        Cadde_excption : コンフィグファイルからCKANURLを取得できない場合、エラーコード : 020101004E
        Cadde_excption : ステータスコード2xxでない場合 エラーコード : 020101005E

    """

(snip)

src/consumer/catalog-search/swagger_server/services/service.py:34

    try:
        config = internal_interface.config_read(__CONFIG_CKAN_URL_FILE_PATH)
        ckan_url = config[__CONFIG_CKAN_URL]
(snip)

また、TLS相互認証のためフォワードプロキシを利用する手順も載っているし、利用者コネクタへのアクセス制限のためのリバースプロキシの設定手順も載っている。

検索について

検索は、src/consumer/catalog-search が担う。以下、このコンポーネントについて。

以下の通り、search APIがエントリポイント。

swagger_server/swagger/swagger.yaml:19

1	operationId: search

ということでコントローラを見る。

swagger_server.controllers.search_controller.search

def search(q=None, x_cadde_search=None, x_cadde_provider_connector_url=None, Authorization=None):  # noqa: E501
    """API. カタログ検索

    横断検索、詳細検索を判定し、 横断検索サイトまたは提供者カタログサイトからカタログ情報を取得する Response: * 処理が成功した場合は200を返す * 処理に失敗した場合は、2xx以外を返す。Responsesセクション参照。 # noqa: E501

    :param q: CKAN検索条件クエリ CKAN APIに準拠
    :type q: str
    :param x-cadde-search: 横断検索、詳細検索を指定する(横断検索:meta、詳細検索:detail)
    :type x-cadde-search: str
    :param x-cadde-provider-connector-url: 提供者コネクタURL
    :type x-cadde-provider-connector-url: str
    :param Authorization: 認証トークン
    :type Authorization: str

    :rtype: None
    """

(snip)

検索は、横断検索（meta）か、詳細検索（detail）か。

swagger_server/controllers/search_controller.py:39

1	search = connexion.request.headers['x-cadde-search']

横断検索は以下。

swagger_server/controllers/search_controller.py:41

if search == 'meta':
    logger.debug(get_message('020101001N', [query_string, search]))

    data = search_catalog_meta(
        query_string, internal_interface, external_interface)

基本的には、コンフィグ（public_ckan.json）にある、公開CKAN（横断検索用カタログ）の情報を取得し、問い合わせを投げるのみ。認証はされない。（認証用トークなどを渡す仕様ではない）これは「公開」なので。

詳細検索は以下。

swagger_server/controllers/search_controller.py:47

else:
    if 'x-cadde-provider-connector-url' in connexion.request.headers:
        provider_connector_url = connexion.request.headers['x-cadde-provider-connector-url']
    else:
        raise CaddeException(message_id='020101002E')

    authorization = None
    if 'Authorization' in connexion.request.headers:
        authorization = connexion.request.headers['Authorization']

    logger.debug(get_message('020101003N', [query_string, log_message_none_parameter_replace(
        provider_connector_url), log_message_none_parameter_replace(authorization), search]))

    data = search_catalog_detail(
        query_string,
        provider_connector_url,
        authorization,
        external_interface)

こちらは、認証情報をヘッダーから取得し、関数に渡している。 swagger_server.services.service.search_catalog_detail 関数が本体。認証情報を渡しているところが違う、基本的には同様。

データ取得について

Swagger YAML定義に基づくと、利用者側コネクタのコネクタメインのエントリポイントは以下。

consumer/connector-main/swagger_server/controllers/files_controller.py:14

def files(authorization=None, resource_url=None, resource_api_type=None, provider=None):  # noqa: E501
    """API. データ取得(NGSI以外)

    CADDEインタフェースを用いて、HTTPサーバ、FTPサーバからファイルを取得する

    Response:
     * 処理が成功した場合は200を返す
     * 処理に失敗した場合は、2xx以外のコードを返す。 Responsesセクションを参照。 # noqa: E501

    :param Authorization: 利用者トークン
    :type Authorization: str
    :param resource_url: リソースURL
    :type resource_url: str
    :param resource_api_type: リソース提供手段識別子
    :type resource_api_type: str
    :param provider: CADDEユーザID（提供者）
    :type provider: str

    :rtype: None
    """

(snip)

基本的には、ユーザ（ないし、ユーザのシステム）から与えられた認証情報（トークン）、リソースURLなどを利用し、リソースURLにアクセスしてファイルを受領する、というもの。

実際に、データを取得するのは以下の部分。

consumer/connector-main/swagger_server/controllers/files_controller.py:54

    data, headers = fetch_data(
        authorization,
        resource_url,
        resource_api_type,
        provider,
        None,
        external_interface)

    response = make_response(data.read(), 200)
    response.headers = headers
    response.headers['Content-Disposition'] = 'attachment; filename=' + \
        get_url_file_name(resource_url)
(snip)

fetch_data関数は、servicesにある。

consumer/connector-main/swagger_server/services/service.py:142

def fetch_data(authorization: str,
               resource_url: str,
               resource_api_type: str,
               provider: str,
               options: dict,
               external_interface: ExternalInterface = ExternalInterface()) -> (BytesIO,
                                                                                dict):
    """
    データ交換I/Fからデータを取得する、もしくはデータ管理から直接データを取得する。

    Args:
        resource_url str : リソースURL
        resource_api_type str : リソース提供手段識別子
        provider str : CADDEユーザID（提供者）
        authorization str : 利用者トークン
        options : dict リクエストヘッダ情報 key:ヘッダ名 value:パラメータ
        external_interface ExternalInterface : GETリクエストを行うインタフェース

    Returns:
        BytesIO :取得データ
        dict: レスポンスヘッダ情報 key:ヘッダ名 value:パラメータ レスポンスヘッダがない場合は空のdictを返す

(snip)

リソースのURLとともに、リソースのAPI種類を受け取る。下記の通り、いまのところ、NGSI、file/ftp、file/httpに対応。

consumer/connector-main/swagger_server/services/service.py:177

1
2
3

    if resource_api_type != 'api/ngsi' and resource_api_type != 'file/ftp' and resource_api_type != 'file/http':
        raise CaddeException('020004001E')
(snip)

認証は以下。

consumer/connector-main/swagger_server/services/service.py:184

    if authorization:
        # 認証トークン検証
        token_introspect_headers = {
            'Authorization': authorization,
            'x-cadde-consumer-connector-id': consumer_connector_id,
            'x-cadde-consumer-connector-secret': consumer_connector_secret
        }
        token_introspect_response = external_interface.http_get(
            __ACCESS_POINT_URL_AUTHENTICATION_AUTHORIZATION_INTROSPECT, token_introspect_headers)

        if token_introspect_response.status_code < 200 or 300 <= token_introspect_response.status_code:
            raise CaddeException(
                message_id='020004002E',
                status_code=token_introspect_response.status_code,
                replace_str_list=[
                    token_introspect_response.text])

        consumer_id = token_introspect_response.headers['x-cadde-consumer-id']

(snip)

利用者コネクタのIDとシークレットキーをヘッダーに入れ、Introspect宛先に問う。上記の通り、基本的にはCADDE固有の認証サーバ？

これを一般的な外部サービス利用可能にするには、実装の変更の必要がありそう。

データ取得部分。 CADDEユーザIDのありなしで挙動が異なる。

まずCADDEユーザIDなしの場合。

consumer/connector-main/swagger_server/services/service.py:212

    # CADDEユーザID（提供者）なし
    if not provider:
        if resource_api_type == 'api/ngsi':
            response_bytes, ngsi_response_headers = provide_data_ngsi(
                resource_url, options)
            header_arry = ngsi_response_headers.keys()
            for key_data in header_arry:
                response_headers[key_data] = ngsi_response_headers[key_data]
        elif resource_api_type == 'file/ftp':
            response_bytes = provide_data_ftp(
                resource_url, external_interface, internal_interface)

        elif resource_api_type == 'file/http':
            response_bytes = provide_data_http(
                resource_url, options, external_interface, internal_interface)

        return response_bytes, response_headers
(snip)

この中で、provide_data_http関数がどこに定義されているかというと、common.swagger_server.services.provide_data_http.provide_data_httpなど。これは common の中にあるが、実はセットアップスクリプトでシンボリックリンクが貼られている。

consumer/setup.sh:18

1	ln -f ../common/swagger_server/services/provide_data_http.py connector-main/swagger_server/services/provide_data_http.py

関数を見てみる。

common/swagger_server/services/provide_data_http.py:24

def provide_data_http(
        resource_url: str,
        headers_dict: dict = None,
        file_get_interface: ExternalInterface = ExternalInterface(),
        config_get_interface: InternalInterface = InternalInterface()) -> BytesIO:
    """
    HTTPサーバからファイルを取得して返却する。
    ※2020年9月版ではダイジェスト認証、TLS証明書認証、OAuth等の認証処理は実施せず、
    ※ベーシック認証のみ実施する。

    Args:
        resource_url str : ファイル取得を行うリソースURL
        headers_dict : 設定するheader {ヘッダー名:パラメータ}
        file_get_interface object : ファイル取得処理を行うインタフェース
        config_get_interface object : コンフィグファイルからの情報取得を行うインタフェース

    Returns:
        BytesIO :取得データ

(snip)

関数の説明にあるとおりだが、データソースに対する認証については、いまの実装ではBASIC認証のみに対応。

    if 0 < len(http_config_domain):
        if __CONFIG_KEY_BASIC_ID not in http_config_domain[0]:
            raise CaddeException(
                '000201004E',
                status_code=None,
                replace_str_list=[__CONFIG_KEY_BASIC_ID])

        if __CONFIG_KEY_BASIC_PASS not in http_config_domain[0]:
            raise CaddeException(
                '000201005E',
                status_code=None,
                replace_str_list=[__CONFIG_KEY_BASIC_PASS])

        auth = (
            http_config_domain[0][__CONFIG_KEY_BASIC_ID],
            http_config_domain[0][__CONFIG_KEY_BASIC_PASS])

(snip)

レスポンスのコンテンツをBytesIOにして戻り値として返す。

common/swagger_server/services/provide_data_http.py:94

if response.status_code == requests.codes.ok:
    return BytesIO(response.content)

if response.status_code == requests.codes.not_found:
    raise CaddeException('000201006E')

if response.status_code == requests.codes.unauthorized:
    raise CaddeException('000201007E')

なお、FTPの場合はSFTPではなく、FTPのみ。 NGSIの場合は、アクセストークンを取得して利用するようになっている。

提供者コネクタ

提供者コネクタの主なエントリポイントは paths./cadde/api/v4/catalog である。つまりカタログ詳細検索APIである。

provider/catalog-search/swagger_server/swagger/swagger.yaml:8

  /cadde/api/v4/catalog:
    get:
      tags:
      - Search
      summary: API. カタログ検索(詳細検索)
      description: |-
        詳細検索リクエストを受け付け、メイン制御に処理を依頼する。
        
        Response:
        * 処理が成功した場合は200を返す。
        * 処理に失敗した場合は、2xx以外を返す。場合によりエラーを示すペイロードがつく場合もある。Responsesセクションを参照すること。
      operationId: search

(snip)

上記の通り、呼び出されるのは search 関数。

provider/catalog-search/swagger_server/controllers/search_controller.py:15

def search(q=None, Authorization=None):  # noqa: E501
    """API. カタログ検索(詳細検索)

    提供者カタログサイトからCKANカタログ情報を取得する. Response: * 処理が成功した場合は200を返す * 処理に失敗した場合は、2xx以外を返す。Responsesセクション参照。 # noqa: E501

    :param q: CKAN検索条件クエリ CKAN APIに準拠
    :type q: str
    :param Authorization: 認証トークン
    :type Authorization: str

    :rtype: None
    """
(snip)

カタログ詳細検索用のクエリ、認証トークンなどを受領し、それを用いて詳細検索用のCKANに問い合わせる。

provider/catalog-search/swagger_server/controllers/search_controller.py:41

1	data = search_catalog_ckan(query_string, authorization, external_interface)

search_catalog_ckan関数は、services内に定義されている。

provider/catalog-search/swagger_server/services/service.py:8

def search_catalog_ckan(
        query_string: str,
        auth_token: str,
        external_interface: ExternalInterface) -> str:
    """
    コネクタメインに詳細検索を送信する

    Args:
        query_string str : 検索条件のクエリストリング
        auth_token str : HTTPリクエストヘッダとしての認証トークン
        external_interface ExternalInterface :  コネクタ外部とのインタフェース

    Returns:
        str : 取得したデータ文字列

    Raises:
        Cadde_excption : ステータスコード200 OKでない場合 エラーコード : 010101002E

    """

    response = external_interface.http_get(
        __ACCESS_POINT_URL + query_string, {'Authorization': auth_token})

    if response.status_code != 200:
        raise CaddeException(
            message_id='010101002E',
            status_code=response.status_code,
            replace_str_list=[
                response.text])
    else:
        return response.text

ちなみに、common側にもあるのだが、そちらはデータ提供者コネクタからは使われていない様子。 common/swagger_server/services/ckan_access.py これは、セットアップスクリプトにより、利用者側コネクタ内にシンボリックリンクが作られるようになっているが、呼び出されている形跡がない？

参考

EDCステータス変化の様子の謎メモ

2024-10-13

Data SpacesEDC

Connector, Data Spaces, EDC

メモ
参考

メモ

EDC/Samples のステータス変化の謎メモ。調べたのは、コミットb7e2220のバージョン。

このバージョンで扱うEDC Connectorのバージョンは以下。

gradle/libs.versions.toml:7

1	edc = "0.8.1"

1	git clone git@github.com:eclipse-edc/Connector.git -b refs/tags/v0.8.1

diff --git a/gradle.properties b/gradle.properties
index 4511d8eb5..1c57d1403 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1,7 +1,8 @@
 group=org.eclipse.edc
-version=0.8.1-SNAPSHOT
+version=0.8.1
 # for now, we're using the same version for the autodoc plugin and the processor, but that could change in the future
-annotationProcessorVersion=0.8.1-SNAPSHOT
-edcGradlePluginsVersion=0.8.1-SNAPSHOT
+annotationProcessorVersion=0.8.1
+edcGradlePluginsVersion=0.8.1
 edcScmUrl=https://github.com/eclipse-edc/Connector.git
 edcScmConnection=scm:git:git@github.com:eclipse-edc/Connector.git
+org.gradle.jvmargs=-Xmx4096M
\ No newline at end of file
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
index bdd4f8d83..ac3efafe5 100644
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@@ -9,7 +9,7 @@ atomikos = "6.0.0"
 awaitility = "4.2.1"
 bouncyCastle-jdk18on = "1.78.1"
 cloudEvents = "4.0.1"
-edc = "0.8.1-SNAPSHOT"
+edc = "0.8.1"
 failsafe = "3.3.2"
 h2 = "2.3.230"
 httpMockServer = "5.15.0"

デバッガをアタッチして動作を確認

ひとまずContract Negotiation。

どうやらProvider側では、Consumerからリクエストが届いたときに、 org.eclipse.edc.protocol.dsp.negotiation.http.api.controller.DspNegotiationApiController#initialContractRequestが呼ばれる様子。

Provider側でContractNegotiationのログが出るのは２箇所。

org.eclipse.edc.connector.controlplane.services.contractnegotiation.ContractNegotiationProtocolServiceImpl#update ここには、PROVIDER型のContractNegotiationが渡されてくる。

もうひとつは org.eclipse.edc.statemachine.AbstractStateEntityManager#update

protected void update(E entity) {
    store.save(entity);
    monitor.debug(() -> "[%s] %s %s is now in state %s"
            .formatted(this.getClass().getSimpleName(), entity.getClass().getSimpleName(),
                    entity.getId(), entity.stateAsString()));
}

org.eclipse.edc.connector.controlplane.contract.negotiation.ProviderContractNegotiationManagerImpl が用いいられる。

型階層は以下の通り。

1
2
3

core/common/lib/state-machine-lib/src/main/java/org/eclipse/edc/statemachine/AbstractStateEntityManager.java
core/control-plane/control-plane-contract/src/main/java/org/eclipse/edc/connector/controlplane/contract/negotiation/AbstractContractNegotiationManager.java
core/control-plane/control-plane-contract/src/main/java/org/eclipse/edc/connector/controlplane/contract/negotiation/ProviderContractNegotiationManagerImpl.java

org.eclipse.edc.connector.controlplane.contract.negotiation.ProviderContractNegotiationManagerImpl内のプロセッサの定義で、リクエストなどが届いたときの動作を定義。

org.eclipse.edc.connector.controlplane.contract.negotiation.ProviderContractNegotiationManagerImpl#configureStateMachineManager

protected StateMachineManager.Builder configureStateMachineManager(StateMachineManager.Builder builder) {
    return builder
            .processor(processNegotiationsInState(OFFERING, this::processOffering))
            .processor(processNegotiationsInState(REQUESTED, this::processRequested))
            .processor(processNegotiationsInState(ACCEPTED, this::processAccepted))
            .processor(processNegotiationsInState(AGREEING, this::processAgreeing))
            .processor(processNegotiationsInState(VERIFIED, this::processVerified))
            .processor(processNegotiationsInState(FINALIZING, this::processFinalizing))
            .processor(processNegotiationsInState(TERMINATING, this::processTerminating));
}

ここで管理されるステータスはいかに定義されている。

org.eclipse.edc.connector.controlplane.contract.spi.types.negotiation.ContractNegotiationStates

public enum ContractNegotiationStates {

    INITIAL(50),
    REQUESTING(100),
    REQUESTED(200),
    OFFERING(300),
    OFFERED(400),
    ACCEPTING(700),
    ACCEPTED(800),
    AGREEING(825),
    AGREED(850),
    VERIFYING(1050),
    VERIFIED(1100),
    FINALIZING(1150),
    FINALIZED(1200),
    TERMINATING(1300),
    TERMINATED(1400);

(snip)

例えば、とあるケースではREQUESTED(200)の次はAGREEING(825)に変わった。

org.eclipse.edc.connector.controlplane.contract.negotiation.ProviderContractNegotiationManagerImpl#processAgreeing がProvider側が合意をするためのメソッド。

以下の処理を行うとAgreement情報が生成される。

org/eclipse/edc/connector/controlplane/contract/negotiation/ProviderContractNegotiationManagerImpl.java:121

var agreement = Optional.ofNullable(negotiation.getContractAgreement())
        .orElseGet(() -> {
            var lastOffer = negotiation.getLastContractOffer();

            return ContractAgreement.Builder.newInstance()
                    .contractSigningDate(clock.instant().getEpochSecond())
                    .providerId(participantId)
                    .consumerId(negotiation.getCounterPartyId())
                    .policy(lastOffer.getPolicy().toBuilder().type(PolicyType.CONTRACT).build())
                    .assetId(lastOffer.getAssetId())
                    .build();
        });

以下のような感じ。

agreement = {ContractAgreement@7424} 
 id = "b092de56-c860-4972-8e09-e00e77ce97c4"
 providerId = "provider"
 consumerId = "consumer"
 contractSigningDate = 1728916940
 assetId = "assetId"
 policy = {Policy@7429} 
  permissions = {ArrayList@7431}  size = 0
  prohibitions = {ArrayList@7432}  size = 0
  obligations = {ArrayList@7433}  size = 0
  profiles = {ArrayList@7434}  size = 0
  extensibleProperties = {HashMap@7435}  size = 0
  inheritsFrom = null
  assigner = null
  assignee = null
  target = "assetId"
  type = {PolicyType@7436} "CONTRACT"

dispatchメソッド。

org/eclipse/edc/connector/controlplane/contract/negotiation/ProviderContractNegotiationManagerImpl.java:136

return dispatch(messageBuilder, negotiation, Object.class)
        .onSuccess((n, result) -> transitionToAgreed(n, agreement))
        .onFailure((n, throwable) -> transitionToAgreeing(n))
        .onFatalError((n, failure) -> transitionToTerminated(n, failure.getFailureDetail()))
        .onRetryExhausted((n, throwable) -> transitionToTerminating(n, format("Failed to send agreement to consumer: %s", throwable.getMessage())))
        .execute("[Provider] send agreement");

上記の通り、成功か失敗か（どのような失敗か）によってステート変更が変わる。

ここに渡ってくるnegotiationは以下のような感じ。

negotiation = {ContractNegotiation@7419} 
 callbackAddresses = {ArrayList@7440}  size = 0
 correlationId = "028d3abb-5086-4324-be77-087095f382c0"
 counterPartyId = "consumer"
 counterPartyAddress = "http://localhost:29194/protocol"
 protocol = "dataspace-protocol-http"
 type = {ContractNegotiation$Type@7444} "PROVIDER"
 contractAgreement = null
 contractOffers = {ArrayList@7445}  size = 1
 protocolMessages = {ProtocolMessages@7446} 
 state = 825
 stateCount = 1
 stateTimestamp = 1728916898826
 traceContext = {HashMap@7447}  size = 0
 errorDetail = null
 pending = false
 updatedAt = 1728916898826
 id = "af2c8a47-022f-450c-87e2-c425de871ab1"
 clock = {Clock$SystemClock@7422} "SystemClock[Z]"
 createdAt = 1728916898526

org.eclipse.edc.connector.controlplane.contract.negotiation.AbstractContractNegotiationManager#dispatch

メッセージビルドの様子。

org/eclipse/edc/connector/controlplane/contract/negotiation/AbstractContractNegotiationManager.java:93

messageBuilder.counterPartyAddress(negotiation.getCounterPartyAddress())
        .counterPartyId(negotiation.getCounterPartyId())
        .protocol(negotiation.getProtocol())
        .processId(Optional.ofNullable(negotiation.getCorrelationId()).orElse(negotiation.getId()));

if (type() == ContractNegotiation.Type.CONSUMER) {
    messageBuilder.consumerPid(negotiation.getId()).providerPid(negotiation.getCorrelationId());
} else {
    messageBuilder.providerPid(negotiation.getId()).consumerPid(negotiation.getCorrelationId());
}

if (negotiation.lastSentProtocolMessage() != null) {
    messageBuilder.id(negotiation.lastSentProtocolMessage());
}

var message = messageBuilder.build();

これによりビルドされるメッセージは以下のようなもの。

message = {ContractAgreementMessage@7463} 
 contractAgreement = {ContractAgreement@7424} 
 id = "c8a7b6dc-7e44-4bcd-9645-a12d5f8690b6"
 processId = "028d3abb-5086-4324-be77-087095f382c0"
 consumerPid = "028d3abb-5086-4324-be77-087095f382c0"
 providerPid = "af2c8a47-022f-450c-87e2-c425de871ab1"
 protocol = "dataspace-protocol-http"
 counterPartyAddress = "http://localhost:29194/protocol"
 counterPartyId = "consumer"

org/eclipse/edc/connector/controlplane/contract/negotiation/AbstractContractNegotiationManager.java:112

1	return entityRetryProcessFactory.doAsyncStatusResultProcess(negotiation, () -> dispatcherRegistry.dispatch(responseType, message));

上記の通り、org.eclipse.edc.spi.message.RemoteMessageDispatcherRegistry を使ってメッセージを送信。実装は org.eclipse.edc.connector.core.message.RemoteMessageDispatcherRegistryImpl である。

org/eclipse/edc/connector/core/message/RemoteMessageDispatcherRegistryImpl.java:41

public <T> CompletableFuture<StatusResult<T>> dispatch(Class<T> responseType, RemoteMessage message) {
    Objects.requireNonNull(message, "Message was null");
    var protocol = message.getProtocol();
    var dispatcher = dispatchers.get(protocol);
    if (dispatcher == null) {
        return failedFuture(new EdcException("No provider dispatcher registered for protocol: " + protocol));
    }
    return dispatcher.dispatch(responseType, message);
}

protocolにはdataspace-protocol-httpが入る。

dispatcherには以下のようなものが入る。

dispatcher = {DspHttpRemoteMessageDispatcherImpl@7489} 
 handlers = {HashMap@7491}  size = 13
 policyScopes = {HashMap@7492}  size = 12
 httpClient = {EdcHttpClientImpl@7493} 
 identityService = {MockIdentityService@7494} 
 policyEngine = {PolicyEngineImpl@7495} 
 tokenDecorator = {DspHttpCoreExtension$lambda@7496} 
 audienceResolver = {IamMockExtension$lambda@7497}

Policyの判定

Policy定義の際に呼び出されるやつ。

org/eclipse/edc/connector/controlplane/api/management/policy/v3/PolicyDefinitionApiV3Controller.java:57

@POST
@Override
public JsonObject createPolicyDefinitionV3(JsonObject request) {
    return createPolicyDefinition(request);
}

コネクタに登録した際に、ログに残るやつ

org/eclipse/edc/connector/controlplane/api/management/policy/BasePolicyDefinitionApiController.java:87

1
2
3

var createdDefinition = service.create(definition)
        .onSuccess(d -> monitor.debug(format("Policy Definition created %s", d.getId())))
        .orElseThrow(exceptionMapper(PolicyDefinition.class, definition.getId()));

コントラクトのバリデーションサービスは以下。

org.eclipse.edc.connector.controlplane.contract.validation.ContractValidationServiceImpl

この中でorg.eclipse.edc.connector.controlplane.contract.validation.ContractValidationServiceImpl#evaluatePolicyが呼ばれる。

org/eclipse/edc/connector/controlplane/contract/validation/ContractValidationServiceImpl.java:154

private Result<Policy> evaluatePolicy(Policy policy, String scope, ParticipantAgent agent, ContractOfferId offerId) {
    var policyContext = PolicyContextImpl.Builder.newInstance().additional(ParticipantAgent.class, agent).build();
    var policyResult = policyEngine.evaluate(scope, policy, policyContext);
    if (policyResult.failed()) {
        return failure(format("Policy in scope %s not fulfilled for offer %s, policy evaluation %s", scope, offerId.toString(), policyResult.getFailureDetail()));
    }
    return Result.success(policy);
}

上記のpolicyEngineには以下が入っている。

policyEngine = {PolicyEngineImpl@7419} 
 constraintFunctions = {TreeMap@7462}  size = 1
 dynamicConstraintFunctions = {ArrayList@7503}  size = 0
 ruleFunctions = {TreeMap@7454}  size = 0
 preValidators = {HashMap@7423}  size = 0
 postValidators = {HashMap@7517}  size = 0
 scopeFilter = {ScopeFilter@7509}

ポリシー評価 org.eclipse.edc.policy.evaluator.PolicyEvaluator

デフォルトのポリシーエンジン org.eclipse.edc.policy.engine.PolicyEngineImpl

元になったインターフェース org.eclipse.edc.policy.engine.spi.PolicyEngine

コントラクトネゴシエーションが走ると、Providerで以下が走る。

org.eclipse.edc.policy.engine.PolicyEngineImpl#evaluate org/eclipse/edc/policy/engine/PolicyEngineImpl.java:69

    public Result<Void> evaluate(String scope, Policy policy, PolicyContext context) {
        var delimitedScope = scope + ".";

        var scopedPreValidators = preValidators.entrySet().stream().filter(entry -> scopeFilter(entry.getKey(), delimitedScope)).flatMap(l -> l.getValue().stream()).toList();

(snip)

評価はPolicyEvaluatorが行う。

org/eclipse/edc/policy/engine/PolicyEngineImpl.java:79

1 2	var evalBuilder = PolicyEvaluator.Builder.newInstance();

org/eclipse/edc/policy/engine/PolicyEngineImpl.java:115

1	var result = evaluator.evaluate(filteredPolicy);

filteredPolicyには以下のようなものが入る。

filteredPolicy = {Policy@7361} 
 permissions = {ArrayList@7364}  size = 0
 prohibitions = {ArrayList@7365}  size = 0
 obligations = {ArrayList@7366}  size = 0
 profiles = {ArrayList@7367}  size = 0
 extensibleProperties = {HashMap@7368}  size = 0
 inheritsFrom = null
 assigner = null
 assignee = null
 target = null
 type = {PolicyType@7369} "SET"

org/eclipse/edc/policy/evaluator/PolicyEvaluator.java:66


public PolicyEvaluationResult evaluate(Policy policy) {
    return policy.accept(this) ? new PolicyEvaluationResult() : new PolicyEvaluationResult(ruleProblems);
}

org.eclipse.edc.policy.evaluator.PolicyEvaluator#visitPolicyが呼ばれる。

org/eclipse/edc/policy/evaluator/PolicyEvaluator.java:71

public Boolean visitPolicy(Policy policy) {
    policy.getPermissions().forEach(permission -> permission.accept(this));
    policy.getProhibitions().forEach(prohibition -> prohibition.accept(this));
    policy.getObligations().forEach(duty -> duty.accept(this));
    return ruleProblems.isEmpty();
}

上記の通り、もしpolicyが空だと何も生じず、ruleProblemsが空なのでTrueが返る。

アセットセレクタ

org.eclipse.edc.connector.controlplane.contract.validation.ContractValidationServiceImpl#validateInitialOffer(org.eclipse.edc.connector.controlplane.contract.spi.validation.ValidatableConsumerOffer, org.eclipse.edc.spi.agent.ParticipantAgent) が用いられる。

org/eclipse/edc/connector/controlplane/contract/validation/ContractValidationServiceImpl.java:144

var testCriteria = new ArrayList<>(consumerOffer.getContractDefinition().getAssetsSelector());
testCriteria.add(new Criterion(Asset.PROPERTY_ID, "=", consumerOffer.getOfferId().assetIdPart()));
if (assetIndex.countAssets(testCriteria) <= 0) {
    return failure("Asset ID from the ContractOffer is not included in the ContractDefinition");
}

AssetIndexの型階層は以下の通り。

1
2
3

AssetIndex (org.eclipse.edc.connector.controlplane.asset.spi.index)
  InMemoryAssetIndex (org.eclipse.edc.connector.controlplane.defaults.storage.assetindex)
  SqlAssetIndex (org.eclipse.edc.connector.controlplane.store.sql.assetindex)

このうち、手元の環境で呼び出されたのはInMemoryAssetIndex。

org/eclipse/edc/connector/controlplane/defaults/storage/assetindex/InMemoryAssetIndex.java:112

1
2
3

public long countAssets(List<Criterion> criteria) {
    return filterBy(criteria).count();
}

org.eclipse.edc.connector.controlplane.defaults.storage.assetindex.InMemoryAssetIndex#filterBy

private Stream<Asset> filterBy(List<Criterion> criteria) {
    var predicate = criteria.stream()
            .map(criterionOperatorRegistry::toPredicate)
            .reduce(x -> true, Predicate::and);

    return cache.values().stream()
            .filter(predicate);
}

クライテリアの評価用のPredicate生成はorg.eclipse.edc.spi.query.CriterionOperatorRegistry。実装はorg.eclipse.edc.query.CriterionOperatorRegistryImpl。

org.eclipse.edc.query.CriterionOperatorRegistryImpl#toPredicate

@Override
public <T> Predicate<T> toPredicate(Criterion criterion) {
    var predicate = operatorPredicates.get(criterion.getOperator().toLowerCase());
    if (predicate == null) {
        throw new IllegalArgumentException(format("Operator [%s] is not supported.", criterion.getOperator()));
    }

    return t -> {

        var operandLeft = (String) criterion.getOperandLeft();

        var property = propertyLookups.stream()
                .map(it -> it.getProperty(operandLeft, t))
                .filter(Objects::nonNull)
                .findFirst()
                .orElse(null);

        if (property == null) {
            return false;
        }

        return predicate.test(property, criterion.getOperandRight());
    };

}

参考

EDC/Samples