2.16.13 要求電文(ヘッダ)とHTTPアダプタ実行環境(共通)プロパティファイルのパラメタの対応関係
HTTPアダプタの要求電文(ヘッダ),HTTPアダプタ実行環境プロパティファイル,およびHTTPアダプタ共通実行環境プロパティファイルで設定できるパラメタの対応関係を次に示します。なお,ここでは要求電文(ヘッダ)の要素名をXPathで表記しています。
同じ内容が要求電文(ヘッダ),HTTPアダプタ実行環境プロパティファイル,HTTPアダプタ実行環境共通プロパティファイルの間で複数設定された場合,次の表でより優先度の高いものが適用されます。
指定個所 |
重複時の優先度 |
---|---|
要求電文(ヘッダ) |
高 |
HTTPアダプタ実行環境プロパティファイル (HCSCサーバ単位の指定:あり) |
| |
HTTPアダプタ実行環境共通プロパティファイル (HCSCサーバ単位の指定:あり) |
| |
HTTPアダプタ実行環境プロパティファイル (HCSCサーバ単位の指定:なし) |
| |
HTTPアダプタ実行環境共通プロパティファイル (HCSCサーバ単位の指定:なし) |
低 |
要求電文(ヘッダ)と各プロパティとの対応を次に示します。
- 〈この項の構成〉
(1) リクエストID
送信ファイルの入力元フォルダ種別属性,または受信ファイルの出力先フォルダ種別属性に作業フォルダを指定する場合は,要求電文(ヘッダ)で指定してください。作業フォルダを使用しない場合は,指定を省略できます。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
リクエストID |
/http-header-request/request-id |
指定できません。 |
指定できません。 |
− |
任意 |
- (凡例)
-
−:デフォルト値はありません。
(2) パート
必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。単一のファイルデータを送信する場合は指定を省略できます。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
パート型 |
/http-header-request/http-body/style |
adphttp.request.body.style |
adphttp.request.body.style |
− |
任意 |
パート名 |
/http-header-request/http-part/message/part-id |
adphttp.request.part.message.part-id |
adphttp.request.part.message.part-id |
− |
任意 |
/http-header-request/http-part/files/file/part-id |
adphttp.request.part.file.<追番>.part-id |
adphttp.request.part.file.<追番>.part-id |
− |
任意 |
- (凡例)
-
−:デフォルト値はありません。
(3) リクエストメソッド
要求電文(ヘッダ),またはどちらかのプロパティファイルで必ず指定してください。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
リクエストメソッド |
/http-header-request/method |
adphttp.request.method |
adphttp.request.method |
− |
必須 |
- (凡例)
-
−:デフォルト値はありません。
(4) リクエストURI
スキーム・オーソリティは,要求電文(ヘッダ),またはどちらかのプロパティファイルで必ず指定してください。
パスは,必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。ルートパス("/")を使用する場合は指定を省略できます。
クエリは,必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。クエリを複数の場所で指定した場合,優先度が低い場所で指定したクエリは優先度が高い場所で指定したクエリですべて上書きされます。複数の場所で指定したクエリの結合はできません。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
スキーム・オーソリティ |
/http-header-request/uri-scheme-authority |
adphttp.request.uri-scheme-authority |
adphttp.request.uri-scheme-authority |
− |
必須 |
パス |
/http-header-request/uri-path |
adphttp.request.uri-path |
adphttp.request.uri-path |
− |
任意 |
クエリ |
/http-header-request/uri-query/任意要素 |
adphttp.request.uri-query.<追番> |
adphttp.request.uri-query.<追番> |
− |
- (凡例)
-
−:デフォルト値はありません。
(5) 認証情報
必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。認証情報を使用しない場合は指定を省略(デフォルト値を使用)できます。
これらのパラメタは常にセットで指定する必要があります。1つの場所に認証値,または認証種別属性を単独で指定することはできません。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
認証値 |
/http-header-request/http-header-Authorization |
adphttp.request.header.authorization |
adphttp.request.header.authorization |
空文字列 |
任意 |
認証種別属性 |
/http-header-request/http-header-Authorization/@type |
adphttp.request.header.authorization.type |
adphttp.request.header.authorization.type |
none |
(6) Content-Type
必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。Content-Typeヘッダの設定をしない場合は指定を省略できます。
文字コード属性の設定が不要な場合は,指定を省略できます。この場合,メディアタイプだけ使用されます。
文字コード属性を単独で指定した場合は,指定が有効になりません。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
メディアタイプ |
/http-header-request/http-header-Content-Type |
adphttp.request.header.content-type |
adphttp.request.header.content-type |
− |
任意 |
/http-header-request/http-part/files/file/Content-Type |
adphttp.request.part.file.<追番>.content-type |
adphttp.request.part.file.<追番>.content-type |
− |
||
文字コード属性 |
/http-header-request/http-header-Content-Type/@charset |
adphttp.request.header.content-type.charset |
adphttp.request.header.content-type.charset |
− |
|
/http-header-request/http-part/message/Content-Type/@charset |
adphttp.request.part.message.content-type.charset |
adphttp.request.part.message.content-type.charset |
− |
||
/http-header-request/http-part/files/file/Content-Type/@charset |
adphttp.request.part.file.<追番>.content-type.charset |
adphttp.request.part.file.<追番>.content-type.charset |
− |
- (凡例)
-
−:デフォルト値はありません。
(7) Cookie
必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。Cookieヘッダの設定をしない場合は指定を省略できます。
Cookie情報,Cookie名属性,送信先ホスト名属性は常にセットで指定する必要があります。
送信先パス属性の設定が不要な場合は,指定を省略できます。この場合,送信先パスの判定が行われないため,すべてのパスに対してCookieが送信されます。
1つの場所にCookie情報,Cookie名属性,送信先ホスト名属性,送信先パス属性を単独で指定することはできません。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
Cookie情報 |
/http-header-request/http-header-Cookies/Cookie |
指定できません。 |
指定できません。 |
− |
任意 |
Cookie名属性 |
/http-header-request/http-header-Cookies/Cookie/@name |
指定できません。 |
指定できません。 |
− |
|
送信先ホスト名属性 |
/http-header-request/http-header-Cookies/Cookie/@host |
指定できません。 |
指定できません。 |
− |
|
送信先パス属性 |
/http-header-request/http-header-Cookies/Cookie/@path |
指定できません。 |
指定できません。 |
− |
- (凡例)
-
−:デフォルト値はありません。
(8) リクエストヘッダ
必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。
リクエストヘッダを複数の場所で指定した場合,優先度が低い場所で指定したリクエストヘッダは優先度が高い場所で指定したリクエストヘッダですべて上書きされます。複数の場所で指定したリクエストヘッダの結合はできません。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
リクエストヘッダ |
/http-header-request/http-header/任意要素 |
adphttp.request.header.userdef.<追番> |
adphttp.request.header.userdef.<追番> |
− |
任意 |
- (凡例)
-
−:デフォルト値はありません。
(9) リクエストボディ(要求電文(ボディ)のデータ送信種別)
必要に応じて要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。リクエストボディを送信しない場合は,指定を省略(デフォルト値を使用)できます。
送信ファイルのパラメタを指定した場合は,このパラメタの指定は無視されます。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
リクエストボディ(要求電文(ボディ)のデータ送信種別) |
/http-header-request/http-part/message/binding |
adphttp.request.part.message.binding |
adphttp.request.part.message.binding |
none |
任意 |
(10) 送信ファイル
要求電文(ボディ)の代わりにファイルをリクエストボディとして送信する場合は,要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。
リクエストボディを送信しない場合や要求電文(ボディ)をリクエストボディとして送信する場合は,指定を省略できます。
これらのパラメタは常にセットで指定する必要があります。1つの場所に入力元フォルダ名,入力元フォルダ種別属性,入力元ファイル名を単独で指定することはできません。
項目 |
高 ← 優先度 → 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
入力元フォルダ名 |
/http-header-request/http-part/files/file/input-folder-name |
adphttp.request.part.file.<追番>.input-folder-name |
adphttp.request.part.file.<追番>.input-folder-name |
− |
任意 |
入力元フォルダ種別属性 |
/http-header-request/http-part/files/file/input-folder-name/@common |
指定できません。 |
指定できません。 |
− |
|
入力元ファイル名 |
/http-header-request/http-part/files/file/local-file-name |
adphttp.request.part.file.<追番>.local-file-name |
adphttp.request.part.file.<追番>.local-file-name |
− |
|
/http-header-request/http-part/files/file/file-name |
adphttp.request.part.file.<追番>.file-name |
adphttp.request.part.file.<追番>.file-name |
− |
- (凡例)
-
−:デフォルト値はありません。
(11) 受信ファイルの出力先
ファイルを受信する場合は,要求電文(ヘッダ),またはどちらかのプロパティファイルで指定してください。ファイルを受信しない場合は,指定を省略できます。
これらのパラメタは常にセットで指定する必要があります。1つの場所に出力先フォルダ名,出力先フォルダ種別属性,または出力先サブフォルダを単独で指定することはできません。
項目 |
高 ← 優先度→ 低 |
デフォルト値 |
指定要否 |
||
---|---|---|---|---|---|
要求電文(ヘッダ) |
HTTPアダプタ実行環境プロパティファイル |
HTTPアダプタ実行環境共通プロパティファイル |
|||
出力先フォルダ名 |
/http-header-request/output-folder-name |
adphttp.request.output-folder-name |
adphttp.request.output-folder-name |
− |
任意 |
出力先フォルダ種別属性 |
/http-header-request/output-folder-name/@common |
指定できません。 |
指定できません。 |
− |
|
出力先サブフォルダ |
/http-header-request/output-sub-folder |
adphttp.request.output-sub-folder |
adphttp.request.output-sub-folder |
− |
- (凡例)
-
−:デフォルト値はありません。