6.3.6　サービスアダプタを指定する要素

service-adapter

1回

サービスアダプタを定義する要素です。

-

name

1回

サービスアダプタ名を指定します。

NCName型

service-id

1回

サービスアダプタのサービスIDを指定します。

1〜8文字の半角英数字およびアンダーバー（_）

max-instance

0または1回

最大インスタンス数を指定します。

0〜65535の整数

protocol-type

1回

次のどれかのサービス種別を指定します。

• SOAPアダプタ（SOAP）

• SessionBeanアダプタ（SessionBean）

• MDB（WS-R）アダプタ（MDB/WS-R）

• MDB（DBキュー）アダプタ（MDB/DBQueue）

• DBアダプタ（DB）

• TP1アダプタ（TP1）

• ファイルアダプタ（File）

• Object Accessアダプタ（ObjectAccess）

• Message Queueアダプタ（MessageQueue）

• FTPアダプタ（FTP）

• ファイル操作アダプタ（FileOperation）

• メールアダプタ（Mail）

• HTTPアダプタ（HTTP）

• コマンドアダプタ（Command）

• SFTPアダプタ（SFTP）

• Kafkaアダプタ（Kafka）

• gRPCアダプタ（gRPC）

• 汎用カスタムアダプタ（Custom）

SOAP

SessionBean

MDB/WS-R

MDB/DBQueue

DB

TP1

File

ObjectAccess

MessageQueue

FTP

FileOperation

Mail

HTTP

Command

SFTP

Kafka

gRPC

Custom

convert-system-exception-to-fault

0または1回

システム例外をフォルトに変換するかどうかを指定します。

• 変換する（true）

• 変換しない（false）

デフォルト値は「false」です。

true

false

soap-definition^※

1回

SOAPアダプタを定義する要素です。protocol-type要素がSOAPの場合だけ指定します。

-

grpc-definition^※

1回

gRPCアダプタを定義する要素です。protocol-type要素がgRPCの場合だけ指定します。

-

session-bean-definition^※

1回

SessionBeanアダプタを定義する要素です。protocol-type要素がSessionBeanの場合だけ指定します。

-

mdb-wsr-definition^※

1回

MDB（WS-R）アダプタを定義する要素です。protocol-type要素がMDB/WS-Rの場合だけ指定します。

-

mdb-dbqueue-definition^※

1回

MDB（DBキュー）アダプタを定義する要素です。protocol-type要素がMDB/DBQueueの場合だけ指定します。

-

custom-definition^※

1回

汎用カスタムアダプタを定義する要素です。protocol-type要素がCustomの場合だけ指定します。

-

protocol-definition^※

1回

次に示すアダプタ以外のアダプタを定義する要素です。

• SOAPアダプタ

• gPRCアダプタ

• SessionBeanアダプタ

• MDB（WS-R）アダプタ

• MDB（DBキュー）アダプタ

• 汎用カスタムアダプタ

protocol-type要素が次のどれかのアダプタの場合に指定します。

• DBアダプタ

• TP1アダプタ

• ファイルアダプタ

• Object Accessアダプタ

• Message Queueアダプタ

• FTPアダプタ

• ファイル操作アダプタ

• メールアダプタ

• HTTPアダプタ

• コマンドアダプタ

• SFTPアダプタ

• Kafkaアダプタ

-

soap-definition

1回

SOAPアダプタを定義する要素です。

-

wsdl-file-path

1回

WSDLファイルのパスを絶対パスまたは相対パス^※で指定します。

1文字以上のstring型

port-name-ref

1回

WSDLに定義されているポート名を指定します。

NCName型

address

0または1回

アドレスを指定します。

この要素を省略した場合，WSDLファイルで定義されたアドレスを使用します。

string型

operations

1回

オペレーションの一覧を定義する要素です。

-

operation

0回以上

オペレーションを定義する要素です。

-

name-ref

1回

WSDLファイルに定義されているオペレーション名を指定します。

NCName型

input-headers

0または1回

要求電文のヘッダ一覧を定義する要素です。

この要素を指定するかどうかで，インポートの対象となるヘッダ電文が次のように異なります。

• 省略した場合

  WSDLファイルに定義されたヘッダ電文をインポートします。

• 指定した場合

  この要素の子要素で定義されたヘッダ電文をインポートします。

-

header

0回以上

要求電文のヘッダを定義する要素です。

-

file-path

1回

電文フォーマットのファイルパスを絶対パスまたは相対パス^※で指定します。

1文字以上のstring型

root-element-name

1回

ルート要素名を指定します。

NCName型

output-headers

0または1回

応答電文のヘッダ一覧を定義する要素です。

この要素を指定するかどうかで，インポートの対象となるヘッダ電文が次のように異なります。

• 省略した場合

  WSDLファイルに定義されたヘッダ電文をインポートします。

• 指定した場合

  この要素の子要素で定義されたヘッダ電文をインポートします。

-

header

0回以上

応答電文のヘッダを定義する要素です。

-

file-path

1回

電文フォーマットのファイルパスを絶対パスまたは相対パス^※で指定します。

1文字以上のstring型

root-element-name

1回

ルート要素名を指定します。

NCName型

client-definition-file-path

1回

クライアント定義ファイルのパスを，絶対パスまたは相対パス^※で指定します。

ファイル名の大文字と小文字は区別されます。

使用しているSOAPモードによって，次のどちらかのファイル名を指定します。

• SOAP1.1モードの場合

  c4webcl.properties

• SOAP1.1/1.2併用モードの場合

  cscwsconf.properties

1文字以上のstring型

basic-authentication

0または1回

ベーシック認証を定義する要素です。

-

user-name

0または1回

ユーザ名を指定します。

1文字以上のstring型

password

0または1回

パスワードを指定します。

1文字以上のstring型

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

0回以上

オペレーション（RPCメソッド）を定義する要素です。

-

name-ref

1回

オペレーション名（gRPC Serviceに定義されているRPCメソッド名）を指定します。

1文字以上のstring型

fault-messages

1回

フォルト電文の一覧を定義する要素です。

-

fault-message

0回または1回

フォルト電文を定義する要素です。

この要素は，修正したフォルト電文フォーマットファイルを使用する場合に使用します。

この要素を省略した場合は，デフォルトのフォルト電文フォーマットファイルが指定したと見なされます。

-

format-file-path

1回

フォルト電文フォーマットのファイルパスを絶対パスまたは相対パス^※1で指定します。

1文字以上のstring型

custom-definition-files

1回

独自定義ファイルの一覧を定義する要素です。

-

session-bean-definition

1回

SessionBeanアダプタを定義する要素です。

-

ear-file-path

1回

EARファイルのパスを絶対パスまたは相対パス^※で指定します。

1文字以上のstring型

session-bean-info

1回

SessionBean情報を定義する要素です。

-

ejb-jar-file-name-ref

1回

EARファイルに格納されているEJB-JARファイル名を指定します。

ファイル名の大文字と小文字は区別されます。

1文字以上のstring型

remote-interface-name-ref

1回

デプロイメント記述子（ejb-jar.xml）に定義されたリモートインタフェース名を指定します。

1文字以上のstring型

address

0または1回

アドレスを指定します。

1文字以上のstring型

client-definition-file-path

1回

クライアント定義ファイルのパスを絶対パスまたは相対パス^※で指定します。

ファイル名はc4webcl.propertiesで指定します。

ファイル名の大文字と小文字は区別されます。

1文字以上のstring型

user-definition-class

1回

ユーザ定義クラス（JARファイル）を定義する要素です。

-

jar-file-path

0回以上

JARファイルのパスを絶対パスまたは相対パス^※で指定します。

重複したファイル名を指定した場合，あとから指定したファイル名が有効になります。

1文字以上のstring型

mdb-wsr-definition

1回

MDB（WS-R）アダプタを定義する要素です。

-

address

0または1回

アドレスを指定します。

1文字以上のstring型

input-body

1回

要求電文を定義する要素です。

-

format

1回

要求電文に電文フォーマットを指定する場合に指定します。

-

file-path

0または1回

電文フォーマットのファイルパスを絶対パスまたは相対パスで指定します。

1文字以上のstring型

mdb-control-info

1回

MDB制御情報を定義する要素です。

-

jms-message-type

0または1回

次に示すどれかのJMSメッセージの種別を指定します。

• テキスト（Text）

• バイト（Byte）

• オブジェクト（Object）

デフォルト値は「Text」です。

Text

Byte

Object

invoke-setting

1回

利用するサービス部品の呼び出し方法を定義する要素です。

-

remote-invoke

1回

呼び出し方法にリモート呼出しを指定する場合に指定します。

remote-invoke要素とlocal-invoke要素はどちらか一方しか指定できません。

-

max-message

0または1回

最大メッセージ数を指定します。

0〜65535の整数

destination-url

0または1回

宛先URLを指定します。

1文字以上のstring型

basic-authentication

0または1回

ベーシック認証を定義する要素です。

-

user-name

0または1回

ユーザ名を指定します。

1文字以上のstring型

password

0または1回

パスワードを指定します。

1文字以上のstring型

RD-area

0または1回

転送キュー作成先RDエリアを指定します。

1文字以上のstring型

sequence-guarantee

0または1回

順序保証するかどうかを指定します。

• 順序保証する（true）

• 順序保証しない（false）

デフォルト値は「false」です。

true

false

local-invoke

1回

呼び出し方法にローカル呼出しを指定する場合に指定します。

この要素には何も値を指定しません。

local-invoke要素とremote-invoke要素はどちらか一方しか指定できません。

-

mdb-dbqueue-definition

1回

MDB（DBキュー）アダプタを定義する要素です。

-

address

0または1回

アドレスを指定します。

1文字以上のstring型

input-body

1回

要求電文を定義する要素です。

-

format

1回

要求電文に電文フォーマットを指定する場合に指定します。

-

file-path

0または1回

電文フォーマットのファイルパスを絶対パスまたは相対パス^※で指定します。

1文字以上のstring型

custom-definition

1回

汎用カスタムアダプタを定義する要素です。

-

operations

1回

オペレーションの一覧を定義する要素です。

-

utility-class

1回

ユーティリティクラス（JARファイル）を定義する要素です。

-

custom-definition-files

1回

独自定義ファイルの一覧を定義する要素です。

-

protocol-definition

1回

次に示すアダプタを定義する要素です。^※

• DBアダプタ

• TP1アダプタ

• ファイルアダプタ

• Object Accessアダプタ

• Message Queueアダプタ

• FTPアダプタ

• ファイル操作アダプタ

• メールアダプタ

• HTTPアダプタ

• コマンドアダプタ

• SFTPアダプタ

• Kafkaアダプタ

-

operations

1回

オペレーションの一覧を定義する要素です。

-

utility-class

1回

ユーティリティクラス（JARファイル）を定義する要素です。

-

custom-definition-files

1回

独自定義ファイルの一覧を定義する要素です。

-

operations

1回

オペレーションの一覧を定義する要素です。

-

operation

0回以上

オペレーションを定義する要素です。

-

name

1回

オペレーション名を指定します。

NCName型かつこの要素間で一意な値

communication-type

0または1回

次に示すどちらかの通信モデルを指定します。

• 同期（SYNC）

• 非同期（ASYNC）

デフォルト値は「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型

fault-messages

0または1回

フォルト電文の一覧を定義する要素です。

この要素は，communication-type要素の値が「SYNC」の場合に指定します。communication-type要素の値が「ASYNC」のとき，この要素の指定は無視されます。

-

fault-message

0回以上

フォルト電文を定義する要素です。

-

name

1回

フォルト名を指定します。

1文字以上のstring型かつfault-message要素間で一意な値

format-file-path

0または1回

電文フォーマットのファイルパスを絶対パスまたは相対パス^※で指定します。

1文字以上のstring型

utility-class

1回

ユーティリティクラス（JARファイル）を定義する要素です。

-

jar-file-path

0回以上

JARファイルのパスを絶対パスまたは相対パス^※で指定します。

この要素の値には，ユーザが作成したJARファイルパスだけを指定します。サービスプラットフォームが提供するJARファイルのパスの指定は不要です。

重複したファイル名を指定した場合，あとから指定したファイル名が有効になります。

1文字以上のstring型

custom-definition-files

1回

独自定義ファイルの一覧を定義する要素です。

-

file-path

0回以上

独自定義ファイルのパスを絶対パスまたは相対パス^※で指定します。

重複したファイル名を指定した場合，あとから指定したファイル名が有効になります。

1文字以上のstring型