Protocol

Overview（概要）

Notifierは、データトランザクションに関する更新・受領状況を、データ提供者と利用者間で共有するための情報を通知する機能を提供する。

本レイヤは以下の領域を対象とする：

• 通知先リスト管理 データ提供者が提供データの登録・更新・削除をデータ利用者に通知する際に必要な通知先リストの管理機能を提供する。

• 通知管理 データ提供者からの通知管理および、データ利用者からの通知情報確認機能を提供する。

Abstract Normative Specification（抽象仕様）

Concepts and Roles（概念および役割）

本プロトコルに必要な概念は以下である。

概念	説明
Data Provider（データ提供者）	データ利用者に対してデータストアに格納されたデータを送信する主体。
Data Consumer（データ利用者）	データ提供者からデータを受信する主体。

Scope（適用範囲）

• Open Dataspacesを介したデータ提供に関わる通知先リスト管理

• Open Dataspacesを介したデータ提供に関わる通知管理

Normative Requirements（規定要件）

通知先リスト管理

• shall: 通知先リストは、データ提供者単位で管理されなければならず、異なるデータ提供者間で通知先リストが共有または混在してはならない。

  • Rationale: データ提供者ごとの通知設定の独立性およびセキュリティを確保するため。

• may: 通知先リストの管理は、複数の通知先を一括で登録・更新・削除する機能を必要に応じて提供してもよい。

  • Rationale: 運用負荷を軽減し、管理作業の効率化を図るため。

• may: 保持するデータを暗号化する場合、CRYPTRECが推奨する暗号方式等の標準的な暗号技術を、必要に応じて参照・採用してもよい。

  • Rationale: 運用要件に合わせた暗号化技術の採用を、検討可能とするため。

通知管理

• should: 通知の管理は、認証情報を用いたデータ提供者や利用者の情報を基に、認証・認可に基づいて行うことを原則とする。

  • Rationale: 前提とするL2やL3レイヤの要件に整合し、通知情報へのアクセス制御が必要であるため。

• may: 通知の管理は、複数通知の一括登録・一括更新・一括削除する機能を必要に応じて提供してもよい。

  • Rationale: 運用負荷を軽減し、管理作業の効率化を図るため。

• may: 保持するデータを暗号化する場合、CRYPTRECが推奨する暗号方式等の標準的な暗号技術を、必要に応じて参照・採用してもよい。

  • Rationale: 運用要件に合わせた暗号化技術の採用を、検討可能とするため。

Non-functional / Cross-layer Requirements（非機能要件 / クロスレイヤ要件）

• Transaction（L2）を介して、本機能が利用されることを前提とする。

• Identity & Trust（L3）のトークンを用いて、本機能が利用されることを前提とする。

Message Types（メッセージ種類）

種類	送信元 ⇒ 送信先	説明
Request	クライアント（Transaction（L2）） ⇒ サーバー（Notifier）	クライアントがサーバー（Notifier）の各機能を実行するために送信するメッセージ。認証情報や要求パラメータを含む。
Response	サーバー（Notifier） ⇒ クライアント（Transaction（L2））	サーバー（Notifier）がリクエストに対する結果を送信するメッセージ。処理結果、エラー情報などを含む。

Protocol Flow（プロトコルフロー）

Notifierを利用する際の、メッセージ交換シーケンスを以下に示す。

Error Handling（エラー処理）

本プロトコルで使用されるエラー処理について記す。

エラー種別	説明	エラー発生時の対応
リクエスト不正	パラメータ不正、必須項目欠落等において返却される。	入力内容を再確認し、正しい入力内容を設定し、再送信を行う。
トークン設定に関するエラー	アクセストークン未設定、無効等において返却される。	アクセストークンを再取得および再設定（必要に応じて再ログインまたはトークン更新）し、再送信を行う。
権限不足エラー	必要な権限不足等において返却される。	該当操作が許可されていない旨を通知する。なお、再送しても成功しないため再送信は行わない。
リソース存在エラー	該当リソースが存在しない等において返却される。	リソースが存在しない旨を通知する。なお、再送しても成功しないため再送信は行わない。
データ不整合エラー	重複データ、排他制御等において返却される。	最新のデータを再取得し、競合を解消させたうえで、再送信を行う。
リクエスト形式エラー	サポートされないリクエスト形式指定時において返却される。	正しいContent-Typeを設定し、再送信を行う。
システムエラー	サーバ内部において何らかの異常発生時に返却される。	継続的に発生する場合はシステム管理者へ通知を行う。なお、再送信については行った操作によって実行要否を行う。

References（参考文献）

• CRYPTREC暗号リスト 参照元