Cosminexus V9 BPM/ESB基盤 サービスプラットフォーム リファレンス
形式
[sftpadp.host-ipaddr=接続するSFTPサーバのIPアドレスまたはホスト名] [sftpadp.host-con-port=接続するSFTPサーバのポート番号] [sftpadp.user=接続するSFTPサーバのログインユーザ名] [sftpadp.client-ipaddr=HCSCサーバのIPアドレス] [sftpadp.client-port.min=セッション確立するポート番号の範囲の最小値] [sftpadp.client-port.max=セッション確立するポート番号の範囲の最大値] [sftpadp.data-compression={true|false}] [sftpadp.strict-hostkey-checking={true|false}] [sftpadp.host-auth-inf-filepath=ホスト公開鍵ファイルの絶対パス] [sftpadp.user-auth-type={password|publickey}] [sftpadp.password-auth-info=パスワード認証のユーザ名] [sftpadp.password-auth-inf-filepath=パスワード認証情報定義ファイルの絶対パス] [sftpadp.publickey-auth-info=公開鍵認証で使用する認証情報のID] [sftpadp.publickey-auth-inf-filepath=公開鍵認証情報定義ファイルの絶対パス] [sftpadp.kex-exchange.algorithm=暗号化通信で使用する鍵交換方式の優先順位] [sftpadp.common-key.cryptosystem.c2s=共通鍵暗号方式の優先順位(クライアントからサーバへの通信)] [sftpadp.common-key.cryptosystem.s2c=共通鍵暗号方式の優先順位(サーバからクライアントへの通信)] [sftpadp.message-authentication-code.c2s=メッセージ認証コード方式の優先順位(クライアントからサーバへの通信)] [sftpadp.message-authentication-code.s2c=メッセージ認証コード方式の優先順位(サーバからクライアントへの通信)] [sftpadp.host-key.algorithm=ホスト認証の方式の優先順位] [sftpadp.data-compression.algorithm.c2s=データ圧縮アルゴリズムの優先順位(クライアントからサーバへの通信)] [sftpadp.data-compression.algorithm.s2c=データ圧縮アルゴリズムの優先順位(サーバからクライアントへの通信)] [sftpadp.session.timeout=セッション接続処理のタイムアウト時間] [sftpadp.session-con.retry.count=セッション確立失敗時のリトライ回数] [sftpadp.session-con.retry.interval=セッション確立失敗時のリトライ間隔] [sftpadp.read-lock.retry.count=共通フォルダの共有ロック失敗時のリトライ回数] [sftpadp.read-lock.retry.interval=共通フォルダの共有ロック失敗時のリトライ間隔] [sftpadp.write-lock.retry.count=共通フォルダの占有ロック失敗時のリトライ回数] [sftpadp.write-lock.retry.interval=共通フォルダの占有ロック失敗時のリトライ間隔] [sftpadp.data-read.timeout=SFTPサーバからの応答監視時間] [sftpadp.methodtrace.level={1|2|3|4|5}] [sftpadp.methodtrace.filenum=保守ログの面数] [sftpadp.methodtrace.filesize=保守ログの1面当たりの最大サイズ] [sftpadp.exptrace.filenum=例外ログの面数] [sftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ] [sftpadp.sftpprotocoltrace.filenum=SFTPプロトコルトレースファイルの面数] [sftpadp.sftpprotocoltrace.filesize=SFTPプロトコルトレースファイルの1面当たりの最大サイズ] |
機能
SFTPアダプタごとの構成情報を設定します。
SFTPアダプタ実行環境プロパティファイルは,SFTPアダプタごとに設定する個別定義ファイルと,すべてのSFTPアダプタに適用される共通定義ファイルの2種類があります。すべてのSFTPアダプタに適用されるSFTPアダプタ実行環境プロパティファイルのことをSFTPアダプタ実行環境共通プロパティファイルと呼びます。
個別のSFTPアダプタ実行環境プロパティファイルとSFTPアダプタ実行環境共通プロパティファイルの両方が設定されている場合,2つのファイルの定義内容がマージされます。同じプロパティが設定されている場合,個別のSFTPアダプタ実行環境プロパティファイルの内容が有効になります。
SFTPアダプタ実行環境プロパティファイルは次の手順で作成してください。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\SFTP\config\templates\adpsftp.properties
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\SFTP\config\<サービスID>.properties
設定できるプロパティ
(1) サーバ情報
sftpadp.host-ipaddr=接続するSFTPサーバのIPアドレスまたはホスト名
接続するSFTPサーバのIPアドレスまたはホスト名を指定します。IPアドレスを指定する場合は,IPv4ドット記法またはIPv6コロン記法で指定してください。
要求電文のhost-ipaddr要素とこのプロパティの両方が設定されている場合は,host-ipaddr要素の設定が優先されます。両方とも設定されていない場合は,リクエスト処理がエラーとなります。host-ipaddr要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.host-con-port=接続するSFTPサーバのポート番号 〜<数字>((1−65535))
接続するSFTPサーバのポート番号を指定します。
要求電文のhost-con-port要素とこのプロパティの両方が設定されている場合は,host-con-port要素の設定が優先されます。両方とも設定されていない場合は,リクエスト処理がエラーとなります。host-con-port要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.user=接続するSFTPサーバのログインユーザ名 〜<文字列>((1−80文字))
接続するSFTPサーバのログインユーザ名を指定します。
使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号を次に示します。
指定するログインユーザには,ファイル操作の実行権限が与えられている必要があります。
要求電文のsftp-user要素とこのプロパティの両方が設定されている場合は,sftp-user要素の設定が優先されます。両方とも設定されていない場合は,リクエスト処理がエラーとなります。sftp-user要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
(2) クライアント情報関連
sftpadp.client-ipaddr=HCSCサーバのIPアドレス
HCSCサーバのIPアドレスを指定します。IPアドレスを指定する場合は,IPv4ドット記法またはIPv6コロン記法で指定してください。
指定されたIPアドレスが不正な場合はシステム例外が発生します。このプロパティの指定を省略した場合は,システムによって自動的に任意のIPアドレスが割り当てられます。
sftpadp.client-port.min=セッション確立するポート番号の範囲の最小値 〜<数字>((1024−65535))
SFTPアダプタがセッションを確立するポート番号の範囲をsftpadp.client-port.maxプロパティと対で指定します。このプロパティにはポート番号の範囲の最小値を指定し,sftpadp.client-port.maxプロパティには最大値を指定してください。これらのプロパティの指定を両方とも省略した場合は,システムによって自動的に任意のポート番号が割り当てられます。
次の場合は,SFTPアダプタの開始時にエラーとなります。
sftpadp.client-port.max=セッション確立するポート番号の範囲の最大値 〜<数字>((1024−65535))
SFTPアダプタがセッションを確立するポート番号の範囲をsftpadp.client-port.minプロパティと対で指定します。このプロパティにはポート番号の範囲の最大値を指定し,sftpadp.client-port.minプロパティには最小値を指定してください。これらのプロパティの指定を両方とも省略した場合は,システムによって自動的に任意のポート番号が割り当てられます。
次の場合は,SFTPアダプタの開始時にエラーとなります。
(3) SFTP設定
sftpadp.data-compression={true|false} 〜<<false>>
転送データを圧縮するかどうかを指定します。
要求電文のdata-compression要素とこのプロパティの両方が設定されている場合は,data-compression要素の設定が優先されます。両方とも設定されていない場合は,デフォルト値が適用されます。data-compression要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.strict-hostkey-checking={true|false} 〜<<false>>
ホスト認証時に厳格なホスト鍵チェックを実施するか指定します。
要求電文のstrict-hostkey-checking要素とこのプロパティの両方が設定されている場合は,strict-hostkey-checking要素の設定が優先されます。両方とも設定されていない場合は,デフォルト値が適用されます。strict-hostkey-checking要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.host-auth-inf-filepath=ホスト公開鍵ファイルの絶対パス
ホスト公開鍵ファイルを絶対パスで指定します。ホスト公開鍵ファイルはユーザが事前に作成し,HCSCサーバの管理者のアクセス権限を付与する必要があります。
指定したホスト公開鍵ファイルが存在しない場合,SFTPアダプタの開始時にエラーとなります。また,厳格なホスト鍵チェックを実施する場合(sftpadp.strict-hostkey-checking=trueを指定)にこのプロパティが設定されていないと,リクエスト処理時にエラーになります。
sftpadp.user-auth-type={password|publickey}
ユーザ認証の方式を指定します。
要求電文のuser-auth-type要素とこのプロパティの両方が設定されている場合は,user-auth-type要素の設定が優先されます。両方とも設定されていない場合は,リクエスト処理がエラーとなります。user-auth-type要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.password-auth-info=パスワード認証のユーザ名 〜<文字列>((1−80文字))
パスワード認証を実施する場合に,パスワード認証に使用するユーザ名を指定します。
csauseraddコマンドで登録したユーザ名を指定してください。使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号を次に示します。
要求電文のuser-auth-info要素とこのプロパティの両方が設定されている場合は,user-auth-info要素の設定が優先されます。user-auth-info要素,sftpadp.publickey-auth-infoプロパティ,およびこのプロパティのどれも設定されていない場合は,リクエスト処理がエラーとなります。user-auth-info要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.password-auth-inf-filepath=パスワード認証情報定義ファイルの絶対パス
パスワード認証を実施する場合に,パスワード認証情報定義ファイルの絶対パスを指定します。csauseraddコマンドで作成したパスワード認証情報定義ファイルを指定してください。
指定するパスワード認証情報定義ファイルには,HCSCサーバの管理者のアクセス権限が必要です。
指定したパスワード認証情報定義ファイルが存在しない場合は,SFTPアダプタの開始時にエラーとなります。また,パスワード認証を実施する場合にこのプロパティが設定されていないと,リクエスト処理時にエラーとなります。
sftpadp.publickey-auth-info=公開鍵認証で使用する認証情報のID 〜<半角英数字とアンダーバー(_)>((1−8文字))
公開鍵認証を実施する場合に,公開鍵認証に使用する認証情報のIDを指定します。csakeyaddコマンドで登録した鍵IDを指定してください。
要求電文のuser-auth-info要素とこのプロパティの両方が設定されている場合は,user-auth-info要素の設定が優先されます。user-auth-info要素,sftpadp.publickey-auth-infoプロパティ,およびこのプロパティのどれも設定されていない場合は,リクエスト処理がエラーとなります。user-auth-info要素については,マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.15 SFTPアダプタを定義する」を参照してください。
sftpadp.publickey-auth-inf-filepath=公開鍵認証情報定義ファイルの絶対パス
公開鍵認証を実施する場合に,公開鍵認証情報定義ファイルの絶対パスを指定します。csakeyaddコマンドで作成した公開鍵認証情報定義ファイルを指定してください。
指定する公開鍵認証情報定義ファイルには,HCSCサーバの管理者のアクセス権限が必要です。
指定した公開鍵認証情報定義ファイルが存在しない場合は,SFTPアダプタの開始時にエラーとなります。また,公開鍵認証を実施する場合にこのプロパティが設定されていないと,リクエスト処理時にエラーとなります。
sftpadp.kex-exchange.algorithm=暗号化通信で使用する鍵交換方式の優先順位
鍵交換方式の優先順位を指定します。鍵交換方式は,暗号化通信を確立するために使用されます。
指定できる鍵交換方式と,デフォルトの優先順位を次の表に示します。これらの鍵交換方式を優先順位の高い順に,「sftpadp.kex-exchange.algorithm=鍵交換方式,鍵交換方式,鍵交換方式」のようにコンマで区切って指定してください。この表にない鍵交換方式を指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | 鍵交換方式 |
---|---|
高 | ecdh-sha2-nistp256 |
↑ | ecdh-sha2-nistp384 |
| | ecdh-sha2-nistp521 |
| | diffie-hellman-group14-sha1 |
| | diffie-hellman-group-exchange-sha256 |
↓ | diffie-hellman-group-exchange-sha1 |
低 | diffie-hellman-group1-sha1 |
sftpadp.common-key.cryptosystem.c2s=共通鍵暗号方式の優先順位(クライアントからサーバへの通信)
クライアントからサーバへの暗号化通信の確立に使用する,共通鍵暗号方式の優先順位を指定します。
指定できる共通鍵暗号方式と,デフォルトの優先順位を次の表に示します。これらの共通鍵暗号方式を優先順位の高い順に,「sftpadp.common-key.cryptosystem.c2s=共通鍵暗号方式,共通鍵暗号方式,共通鍵暗号方式」のようにコンマで区切って指定してください。この表にない共通鍵暗号方式を指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | 共通鍵暗号方式 |
---|---|
高 | aes128-ctr |
↑ | aes128-cbc |
| | 3des-cbc |
| | blowfish-cbc |
| | aes192-ctr |
| | aes192-cbc |
↓ | aes256-ctr |
低 | aes256-cbc |
sftpadp.common-key.cryptosystem.s2c=共通鍵暗号方式の優先順位(サーバからクライアントへの通信)
サーバからクライアントへの暗号化通信の確立に使用する,共通鍵暗号方式の優先順位を指定します。
指定できる共通鍵暗号方式と,デフォルトの優先順位を次の表に示します。これらの共通鍵暗号方式を優先順位の高い順に,「sftpadp.common-key.cryptosystem.s2c=共通鍵暗号方式,共通鍵暗号方式,共通鍵暗号方式」のようにコンマで区切って指定してください。この表にない共通鍵暗号方式を指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | 共通鍵暗号方式 |
---|---|
高 | aes128-ctr |
↑ | aes128-cbc |
| | 3des-cbc |
| | blowfish-cbc |
| | aes192-ctr |
| | aes192-cbc |
↓ | aes256-ctr |
低 | aes256-cbc |
sftpadp.message-authentication-code.c2s=メッセージ認証コード方式の優先順位(クライアントからサーバへの通信)
クライアントからサーバへの通信で使用する,メッセージ認証コード方式(データの改ざんを防ぐ機構)の優先順位を指定します。
指定できるメッセージ認証コード方式と,デフォルトの優先順位を次の表に示します。これらのメッセージ認証コード方式を優先順位の高い順に,「sftpadp.message-authentication-code.c2s=コード方式,コード方式,コード方式」のようにコンマで区切って指定してください。この表にないメッセージ認証コード方式を指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | メッセージ認証コード方式 |
---|---|
高 | hmac-md5 |
↑ | hmac-sha1 |
| | hmac-sha2-256 |
↓ | hmac-sha1-96 |
低 | hmac-md5-96 |
sftpadp.message-authentication-code.s2c=メッセージ認証コード方式の優先順位(サーバからクライアントへの通信)
サーバからクライアントへの通信で使用する,メッセージ認証コード方式(データの改ざんを防ぐ機構)の優先順位を指定します。
指定できるメッセージ認証コード方式と,デフォルトの優先順位を次の表に示します。これらのメッセージ認証コード方式を優先順位の高い順に,「sftpadp.message-authentication-code.s2c=コード方式,コード方式,コード方式」のようにコンマで区切って指定してください。この表にないメッセージ認証コード方式を指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | メッセージ認証コード方式 |
---|---|
高 | hmac-md5 |
↑ | hmac-sha1 |
| | hmac-sha2-256 |
↓ | hmac-sha1-96 |
低 | hmac-md5-96 |
sftpadp.host-key.algorithm=ホスト認証の方式の優先順位
ホスト認証の方式の優先順位を指定します。
指定できるホスト認証の方式と,デフォルトの優先順位を次の表に示します。これらのホスト認証の方式を優先順位の高い順に,「sftpadp.host-key.algorithm=ホスト認証の方式,ホスト認証の方式,ホスト認証の方式」のようにコンマで区切って指定してください。この表にないホスト認証の方式を指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | ホスト認証の方式 |
---|---|
高 | ssh-rsa |
↓ | ssh-dss |
低 | ecdsa-sha2-nistp256 |
sftpadp.data-compression.algorithm.c2s=データ圧縮アルゴリズムの優先順位(クライアントからサーバへの通信)
クライアントからサーバへの通信で使用する,データ圧縮アルゴリズムの優先順位を指定します。
指定できるデータ圧縮アルゴリズムと,デフォルトの優先順位を次の表に示します。これらのデータ圧縮アルゴリズムを優先順位の高い順に,「sftpadp.data-compression.algorithm.c2s=データ圧縮アルゴリズム,データ圧縮アルゴリズム,データ圧縮アルゴリズム」のようにコンマで区切って指定してください。この表にないデータ圧縮アルゴリズムを指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | データ圧縮アルゴリズム |
---|---|
高 | zlib@openssh.com |
低 | zlib |
sftpadp.data-compression.algorithm.s2c=データ圧縮アルゴリズムの優先順位(サーバからクライアントへの通信)
サーバからクライアントへの通信で使用する,データ圧縮アルゴリズムの優先順位を指定します。
指定できるデータ圧縮アルゴリズムと,デフォルトの優先順位を次の表に示します。これらのデータ圧縮アルゴリズムを優先順位の高い順に,「sftpadp.data-compression.algorithm.s2c=データ圧縮アルゴリズム,データ圧縮アルゴリズム,データ圧縮アルゴリズム」のようにコンマで区切って指定してください。この表にないデータ圧縮アルゴリズムを指定すると,SFTPアダプタの開始時にエラーとなります。
デフォルトの優先順位 | データ圧縮アルゴリズム |
---|---|
高 | zlib@openssh.com |
低 | zlib |
(4) セッション接続タイムアウト
sftpadp.session.timeout=セッション接続処理のタイムアウト時間 〜<数字>((1−3600))<<10>>
セッション接続処理のタイムアウトまでの待ち時間を指定します(単位:秒)。
sftpadp.session-con.retry.count=セッション確立失敗時のリトライ回数 〜<数字>((0−10000))<<5>>
相手先のビジーなどによってセッションを確立できなかった場合に,接続をリトライする回数を指定します。0を指定した場合はリトライされません。
sftpadp.session-con.retry.interval=セッション確立失敗時のリトライ間隔 〜<数字>((0−86400))<<2>>
相手先のビジーなどによってセッションを確立できなかった場合,接続をリトライする間隔を指定します(単位:秒)。0を指定した場合は,間隔をあけないでリトライします。
(5) 排他取得タイムアウト
sftpadp.read-lock.retry.count=共通フォルダの共有ロック失敗時のリトライ回数 〜<数字>((0−1024))<<0>>
共通フォルダのファイルの共有ロックに失敗した場合のリトライ回数を指定します。
sftpadp.read-lock.retry.interval=共通フォルダの共有ロック失敗時のリトライ間隔 〜<数字>((1−1024))<<1>>
共通フォルダのファイルの共有ロックに失敗した場合のリトライ間隔を指定します(単位:秒)。
sftpadp.write-lock.retry.count=共通フォルダの占有ロック失敗時のリトライ回数 〜<数字>((0−1024))<<0>>
共通フォルダのファイルの占有ロックに失敗した場合のリトライ回数を指定します。
sftpadp.write-lock.retry.interval=共通フォルダの占有ロック失敗時のリトライ間隔 〜<数字>((1−1024))<<1>>
共通フォルダのファイルの占有ロックに失敗した場合のリトライ間隔を指定します(単位:秒)。
(6) データ読み込みタイムアウト
sftpadp.data-read.timeout=SFTPサーバからの応答監視時間 〜<数字>((1−3600))<<60>>
GETオペレーション実行時のファイルデータ取得やアルゴリズムネゴシエーションの結果取得など,SFTPサーバからの応答の監視時間を指定します(単位:秒)。
指定した時間を経過しても受信が完了しない場合は,例外(エラー)が発生します。
(7) 保守ログ
sftpadp.methodtrace.level={1|2|3|4|5} 〜<<3>>
保守ログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。
出力情報 | 出力レベル | ||||
---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | |
リクエスタサービスメソッドの入口/出口情報(クラス名,メソッド名,引数,戻り値) | × | ○ | ○ | ○ | ○ |
外部(BPなど)のインターフェースの入口/出口情報(クラス名,メソッド名,引数,戻り値) | × | × | ○ | ○ | ○ |
コンポーネント内インターフェースの入口/出口情報(クラス名,メソッド名,引数,戻り値) | × | × | × | ○ | ○ |
デバッグ情報(処理の分岐などの情報) | × | × | × | × | ○ |
sftpadp.methodtrace.filenum=保守ログの面数 〜<数字>((1−16))<<8>>
保守ログの面数を指定します。
sftpadp.methodtrace.filesize=保守ログの1面当たりの最大サイズ 〜<数字>((4096−2147483647))<<2097152>>
保守ログの1面当たりの最大サイズをバイト単位で指定します。
(8) 例外ログ
sftpadp.exptrace.filenum=例外ログの面数 〜<数字>((1−16))<<8>>
例外ログの面数を指定します。
sftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ 〜<数字>((4096−2147483647))<<2097152>>
例外ログの1面当たりの最大サイズをバイト単位で指定します。
(9) SFTPプロトコルトレース
sftpadp.sftpprotocoltrace.filenum=SFTPプロトコルトレースファイルの面数 〜<数字>((1−16)) <<8>>
プロトコルトレースファイルの面数を指定します。
sftpadp.sftpprotocoltrace.filesize=SFTPプロトコルトレースファイルの1面当たりの最大サイズ 〜<数字>((4096−2147483647)) <<2097152>>
プロトコルトレースファイルの1面当たりの最大サイズ数をバイト単位で指定します。
All Rights Reserved. Copyright (C) 2012, 2019, Hitachi, Ltd.