Cosminexus V9 BPM/ESB基盤 サービスプラットフォーム 開発ガイド 受付・アダプタ定義編
SFTPアダプタの定義方法について説明します。
SFTPアダプタの電文フォーマットの定義ファイルはサービスプラットフォームが提供するスキーマを使用します。そのため,電文フォーマットの定義ファイルの作成は不要です。
SFTPアダプタで使用する電文フォーマットの内容について説明します。
ファイルの格納場所は「<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\SFTP\schema」です。
SFTPアダプタの要求電文フォーマットを,オペレーションごとに説明します。
表3-106 要求電文フォーマット(PUTオペレーション)
タグ名 | 種別 | 出現回数※1 | 説明 | ||
---|---|---|---|---|---|
<request> | − | 1回 | − | ||
|
<host-ipaddr> | string | 0または1回 | 接続するSFTPサーバのIPアドレスまたはホスト名です。 Windowsを使用する場合,ループバックIPアドレス(127.0.0.1またはlocalhost)を指定すると,SFTP接続に失敗する場合があります。実IPアドレスまたはホスト名を指定してください。 |
|
<host-con-port> | long | 0または1回 | 接続するSFTPサーバのポート番号です。 1から65535までのポート番号を指定します。 |
||
<sftp-user>※2 | string | 0または1回 | 接続するSFTPサーバのユーザ名を示すタグです。 SFTPサーバが存在するマシンのユーザ名を指定します。 |
||
<data-compression> | boolean | 0または1回 | 転送データを圧縮するかどうかを指定するタグです。 true:転送データを圧縮します。 false:転送データを圧縮しません。 |
||
<host-auth> | − | 0または1回 | ホスト認証に関する設定を示すタグです。 | ||
<strict-hostkey-checking> | boolean | 0または1回 | 厳格なホスト鍵チェックの実施の有無を指定するタグです。 true:厳格なホスト鍵チェックをします。 false:厳格なホスト鍵チェックをしません。 |
||
<overwrite-data> | boolean | 0または1回 | 転送先にファイルが存在する場合の動作を指定するタグです。 true:ファイルを上書きします。 false:ファイルを追記します。 要素が省略された場合は「true」が仮定されます。 |
||
<user-auth> | − | 0または1回 | ユーザ認証に関する設定を示すタグです。 | ||
|
<user-auth-type> | string | 0または1回 | ユーザ認証の形式を示すタグです。 password:パスワード認証です。 publickey:公開鍵認証です。 |
|
<user-auth-info> | string | 0または1回 | ユーザ認証で使用する認証情報を指定するタグです。
|
||
<request-id> | string | 0または1回 | 受付で作成したリクエストIDを示すタグです。 共通フォルダを利用するときは無視されます。 |
||
<local-folder> | string | 1回 | ローカル側フォルダを示すタグです。
|
||
<local-file-name> | string | 1回 | ローカル側ファイル名を示すタグです。
|
||
<remote-path> | string | 1回 | リモートパス名(SFTPサーバに転送するときの転送先パス名)を示すタグです。 | ||
<sftp-commands-before> | string | 0または1回 | ファイル転送前に実行するSFTPコマンドとその引数を示すタグです。 複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。 |
||
<sftp-commands-after> | string | 0または1回 | ファイル転送後に実行するSFTPコマンドとその引数を示すタグです。 複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。 |
表3-107 要求電文フォーマット(GETオペレーション)
タグ名 | 種別 | 出現回数※1 | 説明 | ||
---|---|---|---|---|---|
<request> | − | 1回 | − | ||
|
<host-ipaddr> | string | 0または1回 | 接続するSFTPサーバのIPアドレスまたはホスト名です。 Windowsを使用する場合,ループバックIPアドレス(127.0.0.1またはlocalhost)を指定すると,SFTP接続に失敗する場合があります。実IPアドレスまたはホスト名を指定してください。 |
|
<host-con-port> | long | 0または1回 | 接続するSFTPサーバのポート番号です。 1から65535までのポート番号を指定します。 |
||
<sftp-user>※2 | string | 0または1回 | 接続するSFTPサーバのユーザ名を示すタグです。 SFTPサーバが存在するマシンのユーザ名を指定します。 |
||
<data-compression> | boolean | 0または1回 | 転送データを圧縮するかどうかを指定するタグです。 true:転送データを圧縮します。 false:転送データを圧縮しません。 |
||
<host-auth> | − | 0または1回 | ホスト認証に関する設定を示すタグです。 | ||
<strict-hostkey-checking> | boolean | 0または1回 | 厳格なホスト鍵チェックの実施の有無を指定するタグです。 true:厳格なホスト鍵チェックをします。 false:厳格なホスト鍵チェックをしません。 |
||
<user-auth> | − | 0または1回 | ユーザ認証に関する設定を示すタグです。 | ||
|
<user-auth-type> | string | 0または1回 | ユーザ認証の形式を示すタグです。 password:パスワード認証です。 publickey:公開鍵認証です。 |
|
<user-auth-info> | string | 0または1回 | ユーザ認証で使用する認証情報を指定するタグです。
|
||
<request-id> | string | 0または1回 | 受付で作成したリクエストIDを示すタグです。 共通フォルダを利用するときは無視されます。 |
||
<local-folder> | string | 1回 | ローカル側フォルダを示すタグです。
|
||
<local-file-name> | string | 0または1回 | ローカル側ファイル名を示すタグです。
|
||
<remote-path> | string | 1回 | リモートパス名(SFTPサーバ上にある取得対象パス名)を示すタグです。 | ||
<sftp-commands-before> | string | 0または1回 | ファイル転送前に実行するSFTPコマンドとその引数を示すタグです。 複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。 |
||
<sftp-commands-after> | string | 0または1回 | ファイル転送後に実行するSFTPコマンドとその引数を示すタグです。 複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。 |
表3-108 要求電文フォーマット(GETINFOオペレーション)
タグ名 | 種別 | 出現回数※1 | 説明 | ||
---|---|---|---|---|---|
<request> | − | 1回 | − | ||
|
<host-ipaddr> | string | 0または1回 | 接続するSFTPサーバのIPアドレスまたはホスト名です。 Windowsを使用する場合,ループバックIPアドレス(127.0.0.1またはlocalhost)を指定すると,SFTP接続に失敗する場合があります。実IPアドレスまたはホスト名を指定してください。 |
|
<host-con-port> | long | 0または1回 | 接続するSFTPサーバのポート番号です。 1から65535までのポート番号を指定します。 |
||
<sftp-user>※2 | string | 0または1回 | 接続するSFTPサーバのユーザ名を示すタグです。 SFTPサーバが存在するマシンのユーザ名を指定します。 |
||
<data-compression> | boolean | 0または1回 | 転送データの圧縮の有無を指定するタグです。 true:転送データを圧縮します。 false:転送データを圧縮しません。 |
||
<host-auth> | − | 0または1回 | ホスト認証に関する設定を示すタグです。 | ||
<strict-hostkey-checking> | boolean | 0または1回 | 厳格なホスト鍵チェックの実施の有無を指定するタグです。 true:厳格なホスト鍵チェックをします。 false:厳格なホスト鍵チェックをしません。 |
||
<user-auth> | − | 0または1回 | ユーザ認証に関する設定を示すタグです。 | ||
|
<user-auth-type> | string | 0または1回 | ユーザ認証の形式を示すタグです。 password:パスワード認証です。 publickey:公開鍵認証です。 |
|
<user-auth-info> | string | 0または1回 | ユーザ認証で使用する認証情報を指定するタグです。
|
||
<getinfo-type> | string | 1回 | SFTPサーバから取得する情報の取得種別を指定するタグです。 LIST:ファイル情報の一覧を取得します。 NLST:ファイル名の一覧を取得します。 |
||
<getinfo-path> | string | 0または1回 | 接続するSFTPサーバから取得する情報の取得パスを示すタグです。<getinfo-type>で指定したコマンドを実行するときに指定するパスです。 タグがない場合,リストコマンド実行前にcdコマンドを実行したかどうかで,次のように異なります。
|
||
<sftp-commands-before> | string | 0または1回 | ファイル転送前に実行するSFTPコマンドとその引数を示すタグです。 複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。 |
||
<sftp-commands-after> | string | 0または1回 | ファイル転送後に実行するSFTPコマンドとその引数を示すタグです。 複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。 |
SFTPアダプタの応答電文フォーマットを,オペレーションごとに説明します。
表3-109 応答電文フォーマット(PUTオペレーション)
タグ名 | 種別 | 出現回数 | 説明 | |
---|---|---|---|---|
<response> | − | 1回 | − | |
|
<local-folder> | string | 1回 | ローカル側フォルダを示すタグです。 作業フォルダを利用した場合,属性に「common="false"」が設定されます。値には空白が設定されます。 共通フォルダを利用した場合,属性に「common="true"」が設定されます。値には,要求電文の<local-folder>タグで指定された共通フォルダ定義名が設定されます。 |
<local-file-name> | string | 1回 | ローカル側ファイル名を示すタグです。 要求電文の<local-file-name>で指定した値が設定されます。 |
表3-110 応答電文フォーマット(GETオペレーション)
タグ名 | 種別 | 出現回数 | 説明 | |
---|---|---|---|---|
<response> | − | 1回 | − | |
|
<local-folder> | string | 1回 | ローカル側フォルダを示すタグです。 作業フォルダを利用した場合,属性に「common="false"」が設定されます。値には空白が設定されます。 共通フォルダを利用した場合,属性に「common="true"」が設定されます。値には,要求電文の<local-folder>タグで指定された共通フォルダ定義名が設定されます。 |
<local-file-name> | string | 1回 | ローカル側ファイル名を示すタグです。
|
|
<file-size> | long | 1回 | SFTPサーバから取得したローカルファイルのサイズを示すタグです。 |
表3-111 応答電文フォーマット(GETINFOオペレーション)
タグ名 | 種別 | 出現回数 | 説明 | ||
---|---|---|---|---|---|
<response> | − | 1回 | − | ||
|
<list-info> | − | 1回 | ファイル一覧情報を示すタグです。 | |
<list> | string | 0回以上 | ファイル情報を示すタグです。
|
作成する定義ファイルの種類を次に示します。
各定義ファイルの作成手順を次に示します。定義ファイルは,SFTPアダプタが提供しているテンプレートファイルを利用して作成できます。
データ変換定義画面を利用して,変換元の電文フォーマット定義ファイルおよび変換先の電文フォーマット定義ファイルのデータ変換を定義します。
データ変換の定義方法については,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「6. データ変換の定義」を参照してください。
SFTPアダプタを定義する場合の手順を次に示します。
All Rights Reserved. Copyright (C) 2012, 2019, Hitachi, Ltd.