2.8.2 Kafka受付の電文フォーマットを作成する
Kafka受付では要求電文フォーマットを使用します。応答電文フォーマットの設定は不要です。
Kafka受付で使用する要求電文フォーマットの形式と作成方法について説明します。
- 〈この項の構成〉
(1) ヘッダ電文の電文フォーマット
Kafka受付のヘッダ電文の電文フォーマットは,サービスプラットフォームが提供するスキーマを使用します。そのため,ヘッダ電文の定義ファイルの作成は不要です。
サービスプラットフォームが提供する電文フォーマットのXMLスキーマは,「<サービスプラットフォームのインストールディレクトリ>\CSC\custom-reception\kafka\schema」に格納されています。
Kafka受付の要求電文フォーマットの形式を次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/kafka/request」です。
タグ名 |
種別 |
出現回数 |
説明 |
||||
---|---|---|---|---|---|---|---|
<request> |
− |
1回 |
− |
||||
<record> |
− |
1回 |
レコードの情報 |
||||
<topic> |
string |
1回 |
レコードが格納されているトピックのトピック名が設定されます。 |
||||
<headers> |
− |
0または1回 |
ヘッダ一覧が設定されます。 ヘッダが設定されている場合だけ出現します。 |
||||
<header> |
− |
1回以上 |
headers要素がある場合だけ出現します。 |
||||
<key> |
string |
1回 |
ヘッダのキーが設定されます。 header要素がある場合だけ出現します。 |
||||
<value> |
string |
0または1回 |
ヘッダの値が設定されます。 header要素がある場合だけ出現します。ただし,値がnullの場合は出現しません。 また,空のバイト配列が設定されていた場合は,空要素となります。 |
||||
<key> |
string |
0または1回 |
レコードのキーです。レコードのキーがnullの場合は,出現しません。また,キーがバイト配列で,かつ空のバイト配列が設定されていた場合は,空要素となります。 |
||||
<partition> |
int |
1回 |
レコードが格納されているパーティションIDです。 |
||||
<offset> |
long |
1回 |
レコードのオフセットです。 |
||||
<timestamp> |
long |
1回 |
レコードに設定されているタイムスタンプです。 |
(2) ボディ電文の電文フォーマット
Kafka受付のボディ電文の電文フォーマットについては,スキーマの形式は任意です。ボディ電文の電文種別に合わせてスキーマを作成する必要があります。
ボディ電文は,次の電文形式を使用できます。
-
XML形式
-
バイナリ形式
-
any
JSON-XML変換を行う場合は,ボディ電文の電文フォーマットをJSON変換ツールで生成する必要があります。JSON変換ツールの詳細は,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「13. JSON変換ツールを使用したデータ変換」を参照してください。