6.3.5 ユーザ定義受付（呼出先固定）の一覧を指定する要素
ユーザ定義受付（呼出先固定）の一覧を指定する要素を次に示します。
- 〈この項の構成〉
(1) receptions
|
要素名 |
出現パターン |
内容 |
指定可能値 |
||||
|---|---|---|---|---|---|---|---|
|
receptions |
1回 |
受付の一覧を定義する要素です。 |
- |
||||
|
reception |
0回以上 |
受付を定義する要素です。 |
- |
||||
|
name |
1回 |
受付名を指定します。 |
NCName型かつreception要素間で一意な値 |
||||
|
reception-id |
1回 |
受付IDを指定します。 |
1〜8文字の半角英数字およびアンダーバー（_） |
||||
|
protocol-type |
1回 |
次に示す受付種別を指定します。
|
SOAP TP1/RPC FTP HTTP MessageQueue FileEvent Kafka ScheduleTriggered gRPC Custom |
||||
|
1回 |
SOAP受付を定義する要素です。 この要素はprotocol-type要素に「SOAP」を指定している場合に指定します。※ |
- |
|||||
|
1回 |
gRPC受付を定義する要素です。 この要素はprotocol-type要素に「gRPC」を指定している場合に指定します。※ |
- |
|||||
|
1回 |
カスタム受付を定義する要素です。この要素は，protocol-type要素に「Custom」を指定している場合に指定します。※ |
- |
|||||
|
1回 |
SOAP受付，gRPC受付，またはカスタム受付以外の受付を定義する要素です。 この要素はprotocol-type要素に「SOAP」「gRPC」または「Custom」以外を指定している場合に指定します。※ |
- |
|||||
- 注※
-
soap-definition要素，grpc-definition要素，custom-definition要素，protocol-definition要素のうち，どれか1つの要素を選択して指定します。
(2) soap-definition
|
要素名 |
出現パターン |
内容 |
指定可能値 |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
soap-definition |
1回 |
SOAP受付を定義する要素です。 |
- |
||||||||
|
wsdl-file-path |
1回 |
WSDLファイルを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
||||||||
|
port-name-ref |
1回 |
WSDLに定義されているポート名を指定します。 |
NCName型 |
||||||||
|
context-root |
0または1回 |
コンテキストルートを指定します。 この要素を省略した場合，reception-id要素に指定した値が設定されます。 コンテキストルートは半角英数字，および次に示す文字から構成される1文字以上の文字列で指定します。
|
半角英数字および次に示す半角記号から構成される1文字以上の文字列 / @ + - $ _ . ! ( ) % ~ |
||||||||
|
operations |
1回 |
オペレーションの一覧を定義する要素です。 |
- |
||||||||
|
operation |
0回以上 |
オペレーションを定義する要素です。 |
- |
||||||||
|
name-ref |
1回 |
WSDLファイルに定義されているオペレーション名を指定します。 |
NCName型 |
||||||||
|
input-headers |
0または1回 |
要求電文のヘッダ一覧を定義する要素です。 この要素を指定するかどうかで，インポートの対象となるヘッダ電文が次のように異なります。
|
- |
||||||||
|
header |
0回以上 |
要求電文のヘッダを定義する要素です |
- |
||||||||
|
file-path |
1回 |
電文フォーマットのファイルパスを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
||||||||
|
root-element-name |
1回 |
ルート要素名を指定します。 |
NCName型 |
||||||||
|
output-headers |
0または1回 |
応答電文のヘッダ一覧を定義する要素です。 この要素を指定するかどうかで，インポートの対象となるヘッダ電文が次のように異なります。
|
- |
||||||||
|
header |
0回以上 |
応答電文のヘッダ一覧を定義する要素です。 |
- |
||||||||
|
file-path |
1回 |
電文フォーマットのファイルパスを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
||||||||
|
root-element-name |
1回 |
ルート要素名を指定します。 |
NCName型 |
||||||||
|
1回 |
独自定義ファイルの一覧を定義する要素です。 SOAP1.1モードの場合，この要素以下の指定は無視されます。 |
- |
|||||||||
- 注※
-
相対パスで指定した場合，サービス定義XMLファイルが存在するディレクトリを起点としたパスに変換されます。
(3) grpc-definition
|
要素名 |
出現パターン |
内容 |
指定可能値 |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
grpc-definition |
1回 |
gRPC受付を定義する要素です。 |
- |
||||||||
|
proto-paths |
1回 |
proto-pathの一覧を定義する要素です。 |
- |
||||||||
|
proto-path |
1回以上 |
proto-pathを絶対パスまたは相対パス※1で指定します。 |
1文字以上のstring型 |
||||||||
|
proto-file-path |
1回 |
protoファイルのパスを絶対パスまたは相対パス※1で指定します。※2 |
1文字以上のstring型 |
||||||||
|
grpc-service-name-ref |
1回 |
protoファイルに定義されているgRPC Service名を指定します。※3 |
1文字以上のstring型 |
||||||||
|
operations |
1回 |
オペレーション（RPCメソッド）の一覧を定義する要素です。 |
- |
||||||||
|
operation |
1回 |
オペレーション（RPCメソッド）を定義する要素です。 |
- |
||||||||
|
name-ref |
1回 |
オペレーション名（gRPC Serviceに定義されているRPCメソッド名）を指定します。 |
1文字以上のstring型 |
||||||||
|
fault-messages |
1回 |
フォルト電文の一覧を定義する要素です。 |
- |
||||||||
|
fault-message |
0回または1回 |
フォルト電文を定義する要素です。 この要素は，修正したフォルト電文フォーマットファイルを使用する場合に使用します。 この要素を省略した場合は，デフォルトのフォルト電文フォーマットファイルが指定したと見なされます。 |
- |
||||||||
|
format-file-path |
1回 |
フォルト電文フォーマットのファイルパスを絶対パスまたは相対パス※1で指定します。 |
1文字以上のstring型 |
||||||||
|
1回 |
独自定義ファイルの一覧を定義する要素です。 |
- |
|||||||||
- 注※1
-
相対パスで指定した場合，サービス定義XMLファイルが存在するディレクトリを起点としたパスに変換されます。
- 注※2
-
proto-file-path要素のファイルパスは，proto-path要素に設定したディレクトリパスのうちの，どれか1つの配下となるように設定します。この際，proto-file-path要素とproto-path要素のパスの表現は同じである必要があります。
例えば，次の設定をした場合は，proto-file-path要素のファイルパスはproto-path要素のディレクトリパスの配下に存在しないと見なされ，インポート実行時にエラーとなります。
<proto-paths> <proto-path>./sample</proto-path> </proto-paths> <proto-file-path>sample/helloworld.proto</proto-file-path>上記を正しく設定した例は次のようになります。
<proto-paths> <proto-path>./sample</proto-path> </proto-paths> <proto-file-path>./sample/helloworld.proto</proto-file-path>または
<proto-paths> <proto-path>sample</proto-path> </proto-paths> <proto-file-path>sample/helloworld.proto</proto-file-path>なお，パスセパレータ「/」および「\」は区別されないため，どちらを用いても問題ありません。
- 注※3
-
protoファイルにパッケージ名が定義されている場合，grpc-service-name-ref要素にはパッケージ名を含んだ完全修飾名のgRPC Service名を指定します。指定例を次に示します。
- ＜指定例1＞
-
-
protoファイルのパッケージ名：com.hitachi.sample
-
gRPC Service名：Service1
-
grpc-service-name-ref要素に指定する値：com.hitachi.sample.Service1
-
- ＜指定例2＞
-
-
protoファイルのパッケージ名：定義なし
-
gRPC Service名：Service2
-
grpc-service-name-ref要素に指定する値：Service2
-
(4) custom-definition
|
要素名 |
出現パターン |
内容 |
指定可能値 |
||||
|---|---|---|---|---|---|---|---|
|
custom-definition |
1回 |
カスタム受付を定義する要素です。 |
- |
||||
|
ear-file-path |
1回 |
EARファイルのパスを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
||||
|
1回 |
オペレーションの一覧を定義する要素です。 |
- |
|||||
|
1回 |
独自定義ファイルの一覧を定義する要素です。 |
- |
|||||
- 注※
-
相対パスで指定した場合，サービス定義XMLファイルが存在するディレクトリを起点としたパスに変換されます。
(5) protocol-definition
|
要素名 |
出現パターン |
内容 |
指定可能値 |
||||
|---|---|---|---|---|---|---|---|
|
protocol-definition |
1回 |
SOAP受付，gPRC受付，またはカスタム受付以外の受付を定義する要素です。 |
- |
||||
|
1回 |
オペレーションの一覧を定義する要素です。 |
- |
|||||
|
1回 |
独自定義ファイルの一覧を定義する要素です。 |
- |
|||||
(6) operations
|
要素名 |
出現パターン |
内容 |
指定可能値 |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
operations |
1回 |
オペレーションの一覧を定義する要素です。 |
- |
||||||||
|
operation |
0回以上 |
オペレーションを定義する要素です。 1番目のoperation要素がデフォルトオペレーションに設定されます。 |
- |
||||||||
|
name |
1回 |
オペレーション名を指定します。 |
NCName型かつoperation要素間で一意な値 |
||||||||
|
communication-type |
0または1回 |
次に示すどちらかの通信モデルを指定します。
デフォルト値は「SYNC」です。 |
SYNC ASYNC |
||||||||
|
input-body |
1回 |
要求電文を定義する要素です。 |
- |
||||||||
|
any |
1回 |
要求電文にany型を使う場合に指定します。 この要素には何も値を指定しません。 any要素とformat要素はどちらか一方しか指定できません。 |
- |
||||||||
|
format |
1回 |
要求電文に電文フォーマットを指定する場合に指定します。 format要素とany要素はどちらか一方しか指定できません。 |
- |
||||||||
|
file-path |
0または1回 |
電文フォーマットのファイルパスを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
||||||||
|
output-body |
0または1回 |
応答電文を定義する要素です。 この要素は，communication-type要素の値が「SYNC」の場合に指定します。communication-type要素の値が「ASYNC」のとき，この要素の指定は無視されます。 |
- |
||||||||
|
any |
1回 |
応答電文にany型を使う場合に指定します。 この要素には何も値を指定しません。 any要素とformat要素はどちらか一方しか指定できません。 |
- |
||||||||
|
format |
1回 |
応答電文に電文フォーマットを指定する場合に指定します。 format要素とany要素はどちらか一方しか指定できません。 |
- |
||||||||
|
file-path |
0または1回 |
電文フォーマットのファイルパスを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
||||||||
- 注※
-
相対パスで指定した場合，サービス定義XMLファイルが存在するディレクトリを起点としたパスに変換されます。
(7) custom-definition-files
|
要素名 |
出現パターン |
内容 |
指定可能値 |
|||||
|---|---|---|---|---|---|---|---|---|
|
custom-definition-files |
1回 |
独自定義ファイルの一覧を定義する要素です。 |
- |
|||||
|
file-path |
0回以上 |
独自定義ファイルのパスを絶対パスまたは相対パス※で指定します。 |
1文字以上のstring型 |
|||||
- 注※
-
相対パスで指定した場合，サービス定義XMLファイルが存在するディレクトリを起点としたパスに変換されます。