18.4.2 FTPアダプタの応答電文フォーマット

<この項の構成>
(1) PUTオペレーション
(2) GETオペレーション
(3) GETINFOオペレーション
(4) FTPアダプタが実行したコマンドの出力フォーマットと出力例
(5) FTPコマンドのメッセージフォーマットと出力例

(1) PUTオペレーション

FTPアダプタが呼び出し元のビジネスプロセスに返すPUTオペレーションの応答電文のフォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/put_response」です。

表18-14 応答電文フォーマット(PUTオペレーション)

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

<local-folder>1回ローカル側フォルダを示すタグです。
作業フォルダを利用した場合,属性に「common="false"」が設定されます。値には空白が設定されます。
共通フォルダを利用した場合,属性に「common="true"」が設定されます。値には,要求電文の<local-folder>タグで指定された共通フォルダ定義名が設定されます。
<local-file-name>1回ローカル側ファイル名を示すタグです。
要求電文の<local-file-name>で指定した値が設定されます。
<command-info>1回以上

<command>1回FTPアダプタが実行したコマンドを示すタグです。※1
実行したすべてのFTPコマンドが出力されます。
<command-message>1回以上FTPアダプタが実行したコマンドの表示メッセージを示すタグです。※2
FTPコマンドのメッセージはFTP応答コードとメッセージから構成されます。
メッセージが複数行ある場合,これらが同一の応答コードのときは,一つのタグが生成されます。複数の種類のFTP応答コードがあるときは,このタグも複数生成されます。
(凡例)
-:該当する項目はありません。
注※1
FTPアダプタが実行するコマンドの種類については,「18.2.1 FTPコマンドの実行」を参照してください。
FTPアダプタが実行したコマンドの出力フォーマットと出力例については,「(4) FTPアダプタが実行したコマンドの出力フォーマットと出力例」を参照してください。
注※2
FTPコマンドのメッセージフォーマットと応答例については,「(5) FTPコマンドのメッセージフォーマットと出力例」を参照してください。

(2) GETオペレーション

FTPアダプタが呼び出し元のビジネスプロセスに返すGETオペレーションの応答電文のフォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/get_response」です。

表18-15 応答電文フォーマット(GETオペレーション)

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

<local-folder>1回ローカル側フォルダを示すタグです。
作業フォルダを利用した場合,属性に「common="false"」が設定されます。値には空白が設定されます。
共通フォルダを利用した場合,属性に「common="true"」が設定されます。値には,要求電文の<local-folder>タグで指定された共通フォルダ定義名が設定されます。
<local-file-name>1回ローカル側ファイル名を示すタグです。
作業フォルダを利用する場合
作業フォルダの下に格納したファイル名が設定されます。ファイル名は,「csc_<内部生成された文字>」の形式となります。
共通フォルダを利用する場合
要求電文の<local-file-name>で指定した値が設定されます。
<file-size>1回送受信したリモートファイルのサイズを示すタグです。
FTPサーバから取得したローカルファイルのサイズが設定されます。
<command-info>1回以上

<command>1回FTPアダプタが実行したFTPコマンドを示すタグです。※1
実行したすべてのFTPコマンドが出力されます。
<command-message>1回以上FTPアダプタが実行したコマンドの表示メッセージを示すタグです。※2
FTPコマンドのメッセージはFTP応答コードとメッセージから構成されます。
メッセージが複数行ある場合,これらが同一の応答コードのときは,一つのタグが生成されます。複数の種類のFTP応答コードがあるときは,このタグも複数生成されます。
(凡例)
-:該当する項目はありません。
注※1
FTPアダプタが実行するコマンドの種類については,「18.2.1 FTPコマンドの実行」を参照してください。
FTPアダプタが実行したコマンドの出力フォーマットと出力例については,「(4) FTPアダプタが実行したコマンドの出力フォーマットと出力例」を参照してください。
注※2
FTPコマンドのメッセージフォーマットと応答例については,「(5) FTPコマンドのメッセージフォーマットと出力例」を参照してください。

(3) GETINFOオペレーション

FTPアダプタが呼び出し元のビジネスプロセスに返すGETINFOオペレーションの応答電文のフォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/getinfo_response」です。

表18-16 応答電文フォーマット(GETINFOオペレーション)

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

<local-file-name>1回ローカル側ファイル名を示すタグです。
作業フォルダの下に格納したファイル名が設定されます。ファイル名は,「csc_<内部生成された文字>」の形式となります。
取得した情報は,「UTF-16」の文字セットで出力されます。また,改行コードはCRLFで出力されます。
<reply-code>1回LISTコマンドまたはNLSTコマンドのリプライコードを示すタグです。
LISTコマンドまたはNLSTコマンドを実行したときに,FTPサーバから最後に送られてくるリプライコードとして,次のどれかが設定されます。
  • 200~299
    処理が正常に完了したことを示すコードです。
  • 450または550
    ファイル操作ができなかったことを示すコードです。
なお,LISTコマンドまたはNLSTコマンドで指定したパスが存在しない場合,返されるリプライコードは接続先のFTPサーバによって異なります。
<reply-message>1回LISTコマンドまたはNLSTコマンドのリプライメッセージを示すタグです。
LISTコマンドまたはNLSTコマンドを実行したときに,FTPサーバから最後に送られてきたリプライメッセージが設定されます。
<command-info>1回以上

<command>1回FTPアダプタが実行したFTPコマンドを示すタグです。※1
実行したすべてのFTPコマンドが出力されます。
<command-message>1回以上FTPアダプタが実行したコマンドの表示メッセージを示すタグです。※2
FTPコマンドのメッセージはFTP応答コードとメッセージから構成されます。
メッセージが複数行ある場合,これらが同一の応答コードのときは,一つのタグが生成されます。複数の種類のFTP応答コードがあるときは,このタグも複数生成されます。
(凡例)
-:該当する項目はありません。
注※1
FTPアダプタが実行するコマンドの種類については,「18.2.1 FTPコマンドの実行」を参照してください。
FTPアダプタが実行したコマンドの出力フォーマットと出力例については,「(4) FTPアダプタが実行したコマンドの出力フォーマットと出力例」を参照してください。
注※2
FTPコマンドのメッセージフォーマットと応答例については,「(5) FTPコマンドのメッセージフォーマットと出力例」を参照してください。

(4) FTPアダプタが実行したコマンドの出力フォーマットと出力例

応答電文の<command>タグに出力されるFTPコマンドの出力フォーマットと出力例を次の表に示します。

表18-17 FTPアダプタが実行したコマンドの出力フォーマットと出力例

項番FTPコマンド出力フォーマット出力例備考
1(接続処理)Connected to <xxxxx>.Connected to 10.208.180.254.<xxxxx>はFTPサーバのIPアドレスまたはホスト名です。
2USERUSER <ユーザ名>USER user1
3PASSPASS ********PASS ********パスワードは8個の*で表示されます。
4ACCTACCT <課金情報>ACCT acct1
5TYPETYPE <形式オプション>TYPE A<形式オプション>には「A」または「I」のどちらかが表示されます。
6MODEMODE <転送モードオプション>MODE S<転送モードオプション>には「S」または「C」のどちらかが表示されます。
7PASVPASVPASV
8PORTPORT <aaa>,<bbb>,<ccc>,<ddd>,<mmm>,<nnn>PORT 10,208,182,27,14,160<aaa>,<bbb>,<ccc>,<ddd>はローカル側のIPアドレスです。
<mmm>,<nnn>はポート番号です。ローカル側のデータコネクションポート番号は256*mmm+nnnで表現されます。
9SITESITE FSIZE [<ファイルサイズ>]SITE FSIZE 4096GETオペレーションの場合,<ファイルサイズ>は出力されません。
また,PUTオペレーションの場合,<ファイルサイズ>に転送元ファイルの転送路上のファイルサイズが出力されます。
10転送前コマンドまたはリスト前コマンド<コマンド名> [<コマンド引数>]CWD ./workdir
11STORSTOR <パス名>STOR work/fileA.txt
12APPEAPPE <パス名>APPE work/fileA.txt
13RETRRETR <パス名>RETR fileA.txt
14LISTLIST [<オプション>] [<パス名>]LIST -l work
15NLSTNLST [<オプション>] [<パス名>]NLST -l work
16転送後コマンドまたはリスト後コマンド<コマンド名> [<コマンド引数>]RNFR fileA.txt
RNTO fileB.txt
17QUITQUITQUIT
(凡例)
-:該当する説明はありません。

(5) FTPコマンドのメッセージフォーマットと出力例

応答電文の<command-message>タグに出力されるFTPコマンドのメッセージフォーマット,および出力例を次の表に示します。

表18-18 FTPコマンドのメッセージフォーマットと出力例

条件メッセージフォーマット出力例
単一応答コード<FTP応答コード> <メッセージ>226 File receive OK.
<FTP応答コード>-<メッセージ1>
[<メッセージ2>]

<FTP応答コード> <メッセージn>
214-The following commands are recognized.
ACCT ALLO APPE CDUP ... MDTM MKD
NLST NOOP OPTS PASS ... RMD RNFR
214 Help OK.
複数応答コード<FTP応答コード1> <メッセージ1>
<FTP応答コード2> <メッセージ2>
150 File status okay; about to open data connection.
226 Transfer complete.
注※
nは自然数です。

応答コードおよびメッセージの文字列の内容については,使用しているFTPサーバのドキュメントを参照してください。