20.5.1 FTP受付の要求電文フォーマット

FTP受付の要求電文フォーマットをオペレーションごとに示します。

<この項の構成>
(1) PUTオペレーション
(2) GETオペレーション
(3) GETINFOオペレーション

(1) PUTオペレーション

PUTオペレーションのFTP受付からビジネスプロセスに渡す要求電文フォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/put_request」です。

表20-8 FTP受付の要求電文フォーマット(PUTオペレーション)

タグ名出現回数説明
<request>1回

<ftpclient-ipaddr>1回FTPクライアントのIPアドレスです。
IPアドレスのテキスト表現形式で設定します。
<ftp-user>1回FTPクライアントがUSERコマンドで指定したユーザ名です。
USERコマンドの引数に指定された情報がそのまま設定されます。
<ftp-type>1回FTPクライアントがTYPEコマンドで指定したタイプの情報です。
TYPEコマンドの引数に指定された情報がそのまま設定されます。
<transfer-type>1回転送種別です。次のどちらかが設定されます。
  • APPE
    ファイルへの情報追加
  • STOR
    ファイルの上書き
<transfer-path>1回転送対象ファイルパスです。
FTPクライアントがAPPEコマンド,またはSTORコマンドで指定したパス情報から,先頭の振分定義部分を取り除いたファイルパスの情報が設定されます。
先頭には必ず「/」が設定されます。
<file-name>1回FTPクライアントから送られてきたファイルのデータが書き出された中間ファイルのファイル名です。
<file-size>1回FTPクライアントから送られてきて,中間ファイルに書き出されたデータのサイズです。
<request-id>1回リクエストIDです。FTP受付が生成したリクエストIDが設定されます。
<ftp-commands-before>0または1回転送前に実行するFTPコマンドです。
FTPクライアントから次に示すFTPコマンドが要求されている場合に設定されます。

SITE CSCTHR -B <FTPコマンド>[;<FTPコマンド> …]

この場合,「<FTPコマンド>[;<FTPコマンド> …]」の部分がそのままの形式で設定されます。
ただし,SITE CSCTHRコマンドの引数で指定されたFTPコマンドが,FTPコマンド許可リスト定義機能で許可されていない場合は設定されません。
FTPクライアントからCSCTHRコマンドが複数要求されている場合は,「<FTPコマンド>[;<FTPコマンド> …]」の部分がSITE CSCTHRコマンドを実行した順番にセミコロン(;)で接続されて追加されます。
CSCTHRコマンドが一度も要求されていない場合はこのタグは出力されません。
<ftp-commands-after>0または1回転送後に実行する必要があるFTPコマンドです。
FTPクライアントから次に示すコマンドが要求されている場合に設定されます。

SITE CSCTHR -A <FTPコマンド>[;<FTPコマンド> …]

この場合,「<FTPコマンド>[;<FTPコマンド> …]」の部分がそのままの形式で設定されます。
ただし,SITE CSCTHRコマンドの引数で指定されたFTPコマンドが,FTPコマンド許可リスト定義機能で許可されていない場合は設定されません。
FTPクライアントからCSCTHRコマンドが複数要求されている場合は,「<FTPコマンド>[;<FTPコマンド> …]」の部分がSITE CSCTHRコマンドを実行した順番にセミコロン(;)で接続されて追加されます。
CSCTHRコマンドが一度も要求されていない場合はこのタグは出力されません。
(凡例)
-:該当する項目はありません。
注※
規定の出現回数を超える場合の動作は保証しません。

(2) GETオペレーション

GETオペレーションのFTP受付からビジネスプロセスに渡す要求電文フォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/get_request」です。

表20-9 FTP受付の要求電文フォーマット(GETオペレーション)

タグ名出現回数説明
<request>1回

<ftpclient-ipaddr>1回FTPクライアントのIPアドレスです。
IPアドレスのテキスト表現形式で設定します。
<ftp-user>1回FTPクライアントがUSERコマンドで指定したユーザ名です。
USERコマンドの引数に指定された情報がそのまま設定されます。
<ftp-type>1回FTPクライアントがTYPEコマンドで指定したタイプの情報です。
TYPEコマンドの引数に指定された情報がそのまま設定されます。
<transfer-type>1回転送種別です。次の内容が設定されます。
  • RETR
    ファイルの取得
<transfer-path>1回転送対象ファイルパスです。
FTPクライアントがRETRコマンドで指定したパス情報から,先頭の振分定義部分を取り除いたファイルパスの情報が設定されます。
先頭には必ず「/」が設定されます。
<request-id>1回リクエストIDです。FTP受付が生成したリクエストIDを設定します。
<ftp-commands-before>0または1回転送前に実行する必要があるFTPコマンドです。
FTPクライアントから次に示すFTPコマンドが要求されている場合に設定されます。

SITE CSCTHR -B <FTPコマンド>[;<FTPコマンド> …]

この場合,「<FTPコマンド>[;<FTPコマンド> …]」の部分がそのままの形式で設定されます。
ただし,SITE CSCTHRコマンドの引数で指定されたFTPコマンドが,FTPコマンド許可リスト定義機能で許可されていない場合は設定されません。
FTPクライアントからCSCTHRコマンドが複数要求されている場合は,「<FTPコマンド>[;<FTPコマンド> …]」の部分がSITE CSCTHRコマンドを実行した順番にセミコロン(;)で接続されて追加されます。
CSCTHRコマンドが一度も要求されていない場合はこのタグは出力されません。
<ftp-commands-after>0または1回転送後に実行する必要があるFTPコマンドです。
FTPクライアントから次に示すコマンドが要求されている場合に設定されます。

SITE CSCTHR -A <FTPコマンド>[;<FTPコマンド> …]

この場合,「<FTPコマンド>[;<FTPコマンド> …]」の部分がそのままの形式で設定されます。
ただし,SITE CSCTHRコマンドの引数で指定されたFTPコマンドが,FTPコマンド許可リスト定義機能で許可されていない場合は設定されません。
FTPクライアントからCSCTHRコマンドが複数要求されている場合は,「<FTPコマンド>[;<FTPコマンド> …]」の部分がSITE CSCTHRコマンドを実行した順番にセミコロン(;)で接続されて追加されます。
CSCTHRコマンドが一度も要求されていない場合はこのタグは出力されません。
(凡例)
-:該当する項目はありません。
注※
規定の出現回数を超える場合の動作は保証しません。

(3) GETINFOオペレーション

GETINFOオペレーションのFTP受付からビジネスプロセスに渡す要求電文フォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/getinfo_request」です。

表20-10 FTP受付の要求電文フォーマット(GETINFOオペレーション)

タグ名出現回数説明
<request>1回

<ftpclient-ipaddr>1回FTPクライアントのIPアドレスです。
IPアドレスのテキスト表現形式で設定します。
<ftp-user>1回FTPクライアントがUSERコマンドで指定したユーザ名です。
USERコマンドの引数に指定された情報がそのまま設定されます。
<getinfo-type>1回情報取得種別として,次のどちらかが設定されます。
  • LIST
    ファイル情報の一覧を取得します。
  • NLST
    ファイル名の一覧を取得します。
<getinfo-option>0または1回情報取得オプション情報です。
次の条件をすべて満たす場合は,オプション定義ファイルに設定されている文字列と一致した文字列部分が設定されます。
  • FTPクライアントがLISTコマンドまたはNLSTコマンドで指定した引数の先頭部分が,オプション定義ファイルに設定されている文字列と一致する
  • 引数の先頭部分の後ろに文字列が続いていない,または空白文字になっている
なお,次のどちらかに当てはまる場合,このタグは出力されません。
  • FTPクライアントがLISTコマンドまたはNLSTコマンドで引数を指定しなかった場合
  • FTPクライアントがLISTコマンドまたはNLSTコマンドで指定した引数の先頭部分がオプション定義ファイルに設定されている文字列と一致しなかった場合
<getinfo-path>0または1回情報取得パス情報です。
<getinfo-option>タグが出力されていない場合は,FTPクライアントがLISTコマンドまたはNLSTコマンドで指定した引数がそのまま設定されます。
<getinfo-option>タグが出力されている場合は,FTPクライアントがLISTコマンドまたはNLSTコマンドで指定した引数の先頭から,<getinfo-option>タグに出力されているオプション情報およびその後ろの空白文字を取り除いたパス情報部分が設定されます。
なお,次のどちらかに当てはまる場合,このタグは出力されません。
  • FTPクライアントがLISTコマンドまたはNLSTコマンドで引数を指定しなかった場合
  • FTPクライアントがLISTコマンドまたはNLSTコマンドで指定した引数に,オプション情報しか指定されていなかった場合
<request-id>1回リクエストIDです。FTP受付が生成したリクエストIDを設定します。
<ftp-commands-before>0または1回リストコマンド実行前に実行する必要があるFTPコマンドです。
FTPクライアントから次に示すFTPコマンドが要求されている場合に設定されます。

SITE CSCTHR -B <FTPコマンド>[;<FTPコマンド> …]

この場合,「<FTPコマンド>[;<FTPコマンド> …]」の部分がそのままの形式で設定されます。
ただし,SITE CSCTHRコマンドの引数で指定されたFTPコマンドが,FTPコマンド許可リスト定義機能で許可されていない場合は設定されません。
FTPクライアントからCSCTHRコマンドが複数要求されている場合は,「<FTPコマンド>[;<FTPコマンド> …]」の部分がSITE CSCTHRコマンドを実行した順番にセミコロン(;)で接続されて追加されます。
CSCTHRコマンドが一度も要求されていない場合は,このタグは出力されません。
<ftp-commands-after>0または1回リストコマンド実行後に実行する必要があるFTPコマンドです。
FTPクライアントから次に示すコマンドが要求されている場合に設定されます。

SITE CSCTHR -A <FTPコマンド>[;<FTPコマンド> …]

この場合,「<FTPコマンド>[;<FTPコマンド> …]」の部分がそのままの形式で設定されます。
ただし,SITE CSCTHRコマンドの引数で指定されたFTPコマンドが,FTPコマンド許可リスト定義機能で許可されていない場合は設定されません。
FTPクライアントからCSCTHRコマンドが複数要求されている場合は,「<FTPコマンド>[;<FTPコマンド> …]」の部分がSITE CSCTHRコマンドを実行した順番にセミコロン(;)で接続されて追加されます。
CSCTHRコマンドが一度も要求されていない場合は,このタグは出力されません。
(凡例)
-:該当する項目はありません。
注※
規定の出現回数を超える場合の動作は保証しません。